Mercurial > emacs
annotate lispref/strings.texi @ 27301:8c79b30d8475
*** empty log message ***
author | Richard M. Stallman <rms@gnu.org> |
---|---|
date | Wed, 12 Jan 2000 05:22:30 +0000 |
parents | d2e5f1b7d8e2 |
children | 79122ed1162e |
rev | line source |
---|---|
6550 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
4 @c Free Software Foundation, Inc. | |
6550 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/strings | |
7 @node Strings and Characters, Lists, Numbers, Top | |
8 @comment node-name, next, previous, up | |
9 @chapter Strings and Characters | |
10 @cindex strings | |
11 @cindex character arrays | |
12 @cindex characters | |
13 @cindex bytes | |
14 | |
15 A string in Emacs Lisp is an array that contains an ordered sequence | |
16 of characters. Strings are used as names of symbols, buffers, and | |
24862 | 17 files; to send messages to users; to hold text being copied between |
18 buffers; and for many other purposes. Because strings are so important, | |
6550 | 19 Emacs Lisp has many functions expressly for manipulating them. Emacs |
20 Lisp programs use strings more often than individual characters. | |
21 | |
22 @xref{Strings of Events}, for special considerations for strings of | |
23 keyboard character events. | |
24 | |
25 @menu | |
26 * Basics: String Basics. Basic properties of strings and characters. | |
27 * Predicates for Strings:: Testing whether an object is a string or char. | |
28 * Creating Strings:: Functions to allocate new strings. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
29 * Modifying Strings:: Altering the contents of an existing string. |
6550 | 30 * Text Comparison:: Comparing characters or strings. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
31 * String Conversion:: Converting to and from characters and strings. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
32 * Formatting Strings:: @code{format}: Emacs's analogue of @code{printf}. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
33 * Case Conversion:: Case conversion functions. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
34 * Case Tables:: Customizing case conversion. |
6550 | 35 @end menu |
36 | |
37 @node String Basics | |
38 @section String and Character Basics | |
39 | |
24862 | 40 Characters are represented in Emacs Lisp as integers; |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
41 whether an integer is a character or not is determined only by how it is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
42 used. Thus, strings really contain integers. |
6550 | 43 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
44 The length of a string (like any array) is fixed, and cannot be |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
45 altered once the string exists. Strings in Lisp are @emph{not} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
46 terminated by a distinguished character code. (By contrast, strings in |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
47 C are terminated by a character with @sc{ascii} code 0.) |
6550 | 48 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
49 Since strings are arrays, and therefore sequences as well, you can |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
50 operate on them with the general array and sequence functions. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
51 (@xref{Sequences Arrays Vectors}.) For example, you can access or |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
52 change individual characters in a string using the functions @code{aref} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
53 and @code{aset} (@pxref{Array Functions}). |
6550 | 54 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
55 There are two text representations for non-@sc{ascii} characters in |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
56 Emacs strings (and in buffers): unibyte and multibyte (@pxref{Text |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
57 Representations}). An @sc{ascii} character always occupies one byte in a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
58 string; in fact, when a string is all @sc{ascii}, there is no real |
24862 | 59 difference between the unibyte and multibyte representations. |
60 For most Lisp programming, you don't need to be concerned with these two | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
61 representations. |
6550 | 62 |
63 Sometimes key sequences are represented as strings. When a string is | |
64 a key sequence, string elements in the range 128 to 255 represent meta | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
65 characters (which are large integers) rather than character |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
66 codes in the range 128 to 255. |
6550 | 67 |
68 Strings cannot hold characters that have the hyper, super or alt | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
69 modifiers; they can hold @sc{ascii} control characters, but no other |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
70 control characters. They do not distinguish case in @sc{ascii} control |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
71 characters. If you want to store such characters in a sequence, such as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
72 a key sequence, you must use a vector instead of a string. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
73 @xref{Character Type}, for more information about the representation of meta |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
74 and other modifiers for keyboard input characters. |
6550 | 75 |
12098 | 76 Strings are useful for holding regular expressions. You can also |
77 match regular expressions against strings (@pxref{Regexp Search}). The | |
78 functions @code{match-string} (@pxref{Simple Match Data}) and | |
79 @code{replace-match} (@pxref{Replacing Match}) are useful for | |
80 decomposing and modifying strings based on regular expression matching. | |
81 | |
6550 | 82 Like a buffer, a string can contain text properties for the characters |
83 in it, as well as the characters themselves. @xref{Text Properties}. | |
12098 | 84 All the Lisp primitives that copy text from strings to buffers or other |
85 strings also copy the properties of the characters being copied. | |
6550 | 86 |
87 @xref{Text}, for information about functions that display strings or | |
88 copy them into buffers. @xref{Character Type}, and @ref{String Type}, | |
89 for information about the syntax of characters and strings. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
90 @xref{Non-ASCII Characters}, for functions to convert between text |
24862 | 91 representations and to encode and decode character codes. |
6550 | 92 |
93 @node Predicates for Strings | |
94 @section The Predicates for Strings | |
95 | |
96 For more information about general sequence and array predicates, | |
97 see @ref{Sequences Arrays Vectors}, and @ref{Arrays}. | |
98 | |
99 @defun stringp object | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
100 This function returns @code{t} if @var{object} is a string, @code{nil} |
6550 | 101 otherwise. |
102 @end defun | |
103 | |
104 @defun char-or-string-p object | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
105 This function returns @code{t} if @var{object} is a string or a |
6550 | 106 character (i.e., an integer), @code{nil} otherwise. |
107 @end defun | |
108 | |
109 @node Creating Strings | |
110 @section Creating Strings | |
111 | |
112 The following functions create strings, either from scratch, or by | |
113 putting strings together, or by taking them apart. | |
114 | |
115 @defun make-string count character | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
116 This function returns a string made up of @var{count} repetitions of |
6550 | 117 @var{character}. If @var{count} is negative, an error is signaled. |
118 | |
119 @example | |
120 (make-string 5 ?x) | |
121 @result{} "xxxxx" | |
122 (make-string 0 ?x) | |
123 @result{} "" | |
124 @end example | |
125 | |
126 Other functions to compare with this one include @code{char-to-string} | |
127 (@pxref{String Conversion}), @code{make-vector} (@pxref{Vectors}), and | |
128 @code{make-list} (@pxref{Building Lists}). | |
129 @end defun | |
130 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
131 @defun string &rest characters |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
132 This returns a string containing the characters @var{characters}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
133 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
134 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
135 (string ?a ?b ?c) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
136 @result{} "abc" |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
137 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
138 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
139 |
6550 | 140 @defun substring string start &optional end |
12098 | 141 This function returns a new string which consists of those characters |
6550 | 142 from @var{string} in the range from (and including) the character at the |
143 index @var{start} up to (but excluding) the character at the index | |
144 @var{end}. The first character is at index zero. | |
145 | |
146 @example | |
147 @group | |
148 (substring "abcdefg" 0 3) | |
149 @result{} "abc" | |
150 @end group | |
151 @end example | |
152 | |
153 @noindent | |
154 Here the index for @samp{a} is 0, the index for @samp{b} is 1, and the | |
155 index for @samp{c} is 2. Thus, three letters, @samp{abc}, are copied | |
156 from the string @code{"abcdefg"}. The index 3 marks the character | |
157 position up to which the substring is copied. The character whose index | |
158 is 3 is actually the fourth character in the string. | |
159 | |
160 A negative number counts from the end of the string, so that @minus{}1 | |
161 signifies the index of the last character of the string. For example: | |
162 | |
163 @example | |
164 @group | |
165 (substring "abcdefg" -3 -1) | |
166 @result{} "ef" | |
167 @end group | |
168 @end example | |
169 | |
170 @noindent | |
171 In this example, the index for @samp{e} is @minus{}3, the index for | |
172 @samp{f} is @minus{}2, and the index for @samp{g} is @minus{}1. | |
173 Therefore, @samp{e} and @samp{f} are included, and @samp{g} is excluded. | |
174 | |
175 When @code{nil} is used as an index, it stands for the length of the | |
176 string. Thus, | |
177 | |
178 @example | |
179 @group | |
180 (substring "abcdefg" -3 nil) | |
181 @result{} "efg" | |
182 @end group | |
183 @end example | |
184 | |
185 Omitting the argument @var{end} is equivalent to specifying @code{nil}. | |
186 It follows that @code{(substring @var{string} 0)} returns a copy of all | |
187 of @var{string}. | |
188 | |
189 @example | |
190 @group | |
191 (substring "abcdefg" 0) | |
192 @result{} "abcdefg" | |
193 @end group | |
194 @end example | |
195 | |
196 @noindent | |
197 But we recommend @code{copy-sequence} for this purpose (@pxref{Sequence | |
198 Functions}). | |
199 | |
12098 | 200 If the characters copied from @var{string} have text properties, the |
201 properties are copied into the new string also. @xref{Text Properties}. | |
202 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
203 @code{substring} also accepts a vector for the first argument. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
204 For example: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
205 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
206 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
207 (substring [a b (c) "d"] 1 3) |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
208 @result{} [b (c)] |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
209 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
210 |
6550 | 211 A @code{wrong-type-argument} error is signaled if either @var{start} or |
212 @var{end} is not an integer or @code{nil}. An @code{args-out-of-range} | |
213 error is signaled if @var{start} indicates a character following | |
214 @var{end}, or if either integer is out of range for @var{string}. | |
215 | |
216 Contrast this function with @code{buffer-substring} (@pxref{Buffer | |
217 Contents}), which returns a string containing a portion of the text in | |
218 the current buffer. The beginning of a string is at index 0, but the | |
219 beginning of a buffer is at index 1. | |
220 @end defun | |
221 | |
222 @defun concat &rest sequences | |
223 @cindex copying strings | |
224 @cindex concatenating strings | |
225 This function returns a new string consisting of the characters in the | |
12098 | 226 arguments passed to it (along with their text properties, if any). The |
227 arguments may be strings, lists of numbers, or vectors of numbers; they | |
228 are not themselves changed. If @code{concat} receives no arguments, it | |
229 returns an empty string. | |
6550 | 230 |
231 @example | |
232 (concat "abc" "-def") | |
233 @result{} "abc-def" | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
234 (concat "abc" (list 120 121) [122]) |
6550 | 235 @result{} "abcxyz" |
236 ;; @r{@code{nil} is an empty sequence.} | |
237 (concat "abc" nil "-def") | |
238 @result{} "abc-def" | |
239 (concat "The " "quick brown " "fox.") | |
240 @result{} "The quick brown fox." | |
241 (concat) | |
242 @result{} "" | |
243 @end example | |
244 | |
245 @noindent | |
246 The @code{concat} function always constructs a new string that is | |
247 not @code{eq} to any existing string. | |
248 | |
249 When an argument is an integer (not a sequence of integers), it is | |
250 converted to a string of digits making up the decimal printed | |
12067 | 251 representation of the integer. @strong{Don't use this feature; we plan |
252 to eliminate it. If you already use this feature, change your programs | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
253 now!} The proper way to convert an integer to its decimal printed form |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
254 is with @code{format} (@pxref{Formatting Strings}) or |
11141
6f6c571ad0c0
Say not to use concat for integers.
Richard M. Stallman <rms@gnu.org>
parents:
8590
diff
changeset
|
255 @code{number-to-string} (@pxref{String Conversion}). |
6550 | 256 |
257 @example | |
258 @group | |
259 (concat 137) | |
260 @result{} "137" | |
261 (concat 54 321) | |
262 @result{} "54321" | |
263 @end group | |
264 @end example | |
265 | |
266 For information about other concatenation functions, see the | |
267 description of @code{mapconcat} in @ref{Mapping Functions}, | |
268 @code{vconcat} in @ref{Vectors}, and @code{append} in @ref{Building | |
269 Lists}. | |
270 @end defun | |
271 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
272 @defun split-string string separators |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
273 This function splits @var{string} into substrings at matches for the regular |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
274 expression @var{separators}. Each match for @var{separators} defines a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
275 splitting point; the substrings between the splitting points are made |
24862 | 276 into a list, which is the value returned by @code{split-string}. |
277 If @var{separators} is @code{nil} (or omitted), | |
278 the default is @code{"[ \f\t\n\r\v]+"}. | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
279 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
280 For example, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
281 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
282 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
283 (split-string "Soup is good food" "o") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
284 @result{} ("S" "up is g" "" "d f" "" "d") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
285 (split-string "Soup is good food" "o+") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
286 @result{} ("S" "up is g" "d f" "d") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
287 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
288 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
289 When there is a match adjacent to the beginning or end of the string, |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
290 this does not cause a null string to appear at the beginning or end |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
291 of the list: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
292 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
293 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
294 (split-string "out to moo" "o+") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
295 @result{} ("ut t" " m") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
296 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
297 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
298 Empty matches do count, when not adjacent to another match: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
299 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
300 @example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
301 (split-string "Soup is good food" "o*") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
302 @result{}("S" "u" "p" " " "i" "s" " " "g" "d" " " "f" "d") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
303 (split-string "Nice doggy!" "") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
304 @result{}("N" "i" "c" "e" " " "d" "o" "g" "g" "y" "!") |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
305 @end example |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
306 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
307 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
308 @node Modifying Strings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
309 @section Modifying Strings |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
310 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
311 The most basic way to alter the contents of an existing string is with |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
312 @code{aset} (@pxref{Array Functions}). @code{(aset @var{string} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
313 @var{idx} @var{char})} stores @var{char} into @var{string} at index |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
314 @var{idx}. Each character occupies one or more bytes, and if @var{char} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
315 needs a different number of bytes from the character already present at |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
316 that index, @code{aset} signals an error. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
317 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
318 A more powerful function is @code{store-substring}: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
319 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
320 @defun store-substring string idx obj |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
321 This function alters part of the contents of the string @var{string}, by |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
322 storing @var{obj} starting at index @var{idx}. The argument @var{obj} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
323 may be either a character or a (smaller) string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
324 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
325 Since it is impossible to change the length of an existing string, it is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
326 an error if @var{obj} doesn't fit within @var{string}'s actual length, |
24862 | 327 or if any new character requires a different number of bytes from the |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
328 character currently present at that point in @var{string}. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
329 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
330 |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
331 @need 2000 |
6550 | 332 @node Text Comparison |
333 @section Comparison of Characters and Strings | |
334 @cindex string equality | |
335 | |
336 @defun char-equal character1 character2 | |
337 This function returns @code{t} if the arguments represent the same | |
338 character, @code{nil} otherwise. This function ignores differences | |
339 in case if @code{case-fold-search} is non-@code{nil}. | |
340 | |
341 @example | |
342 (char-equal ?x ?x) | |
343 @result{} t | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
344 (let ((case-fold-search nil)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
345 (char-equal ?x ?X)) |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
346 @result{} nil |
6550 | 347 @end example |
348 @end defun | |
349 | |
350 @defun string= string1 string2 | |
351 This function returns @code{t} if the characters of the two strings | |
24862 | 352 match exactly. |
353 Case is always significant, regardless of @code{case-fold-search}. | |
6550 | 354 |
355 @example | |
356 (string= "abc" "abc") | |
357 @result{} t | |
358 (string= "abc" "ABC") | |
359 @result{} nil | |
360 (string= "ab" "ABC") | |
361 @result{} nil | |
362 @end example | |
12067 | 363 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
364 The function @code{string=} ignores the text properties of the two |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
365 strings. When @code{equal} (@pxref{Equality Predicates}) compares two |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
366 strings, it uses @code{string=}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
367 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
368 If the strings contain non-@sc{ascii} characters, and one is unibyte |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
369 while the other is multibyte, then they cannot be equal. @xref{Text |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
370 Representations}. |
6550 | 371 @end defun |
372 | |
373 @defun string-equal string1 string2 | |
374 @code{string-equal} is another name for @code{string=}. | |
375 @end defun | |
376 | |
377 @cindex lexical comparison | |
378 @defun string< string1 string2 | |
379 @c (findex string< causes problems for permuted index!!) | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
380 This function compares two strings a character at a time. It |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
381 scans both the strings at the same time to find the first pair of corresponding |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
382 characters that do not match. If the lesser character of these two is |
6550 | 383 the character from @var{string1}, then @var{string1} is less, and this |
384 function returns @code{t}. If the lesser character is the one from | |
385 @var{string2}, then @var{string1} is greater, and this function returns | |
386 @code{nil}. If the two strings match entirely, the value is @code{nil}. | |
387 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
388 Pairs of characters are compared according to their character codes. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
389 Keep in mind that lower case letters have higher numeric values in the |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
390 @sc{ascii} character set than their upper case counterparts; digits and |
6550 | 391 many punctuation characters have a lower numeric value than upper case |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
392 letters. An @sc{ascii} character is less than any non-@sc{ascii} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
393 character; a unibyte non-@sc{ascii} character is always less than any |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
394 multibyte non-@sc{ascii} character (@pxref{Text Representations}). |
6550 | 395 |
396 @example | |
397 @group | |
398 (string< "abc" "abd") | |
399 @result{} t | |
400 (string< "abd" "abc") | |
401 @result{} nil | |
402 (string< "123" "abc") | |
403 @result{} t | |
404 @end group | |
405 @end example | |
406 | |
407 When the strings have different lengths, and they match up to the | |
408 length of @var{string1}, then the result is @code{t}. If they match up | |
409 to the length of @var{string2}, the result is @code{nil}. A string of | |
410 no characters is less than any other string. | |
411 | |
412 @example | |
413 @group | |
414 (string< "" "abc") | |
415 @result{} t | |
416 (string< "ab" "abc") | |
417 @result{} t | |
418 (string< "abc" "") | |
419 @result{} nil | |
420 (string< "abc" "ab") | |
421 @result{} nil | |
422 (string< "" "") | |
423 @result{} nil | |
424 @end group | |
425 @end example | |
426 @end defun | |
427 | |
428 @defun string-lessp string1 string2 | |
429 @code{string-lessp} is another name for @code{string<}. | |
430 @end defun | |
431 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
432 @defun compare-strings string1 start1 end1 string2 start2 end2 &optional ignore-case |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
433 This function compares the specified part of @var{string1} with the |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
434 specified part of @var{string2}. The specified part of @var{string1} |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
435 runs from index @var{start1} up to index @var{end1} (@code{nil} means |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
436 the end of the string). The specified part of @var{string2} runs from |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
437 index @var{start2} up to index @var{end2} (@code{nil} means the end of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
438 the string). |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
439 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
440 The strings are both converted to multibyte for the comparison |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
441 (@pxref{Text Representations}) so that a unibyte string can be equal to |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
442 a multibyte string. If @var{ignore-case} is non-@code{nil}, then case |
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
443 is ignored, so that upper case letters can be equal to lower case letters. |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
444 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
445 If the specified portions of the two strings match, the value is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
446 @code{t}. Otherwise, the value is an integer which indicates how many |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
447 leading characters agree, and which string is less. Its absolute value |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
448 is one plus the number of characters that agree at the beginning of the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
449 two strings. The sign is negative if @var{string1} (or its specified |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
450 portion) is less. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
451 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
452 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
453 @defun assoc-ignore-case key alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
454 This function works like @code{assoc}, except that @var{key} must be a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
455 string, and comparison is done using @code{compare-strings}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
456 Case differences are ignored in this comparison. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
457 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
458 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
459 @defun assoc-ignore-representation key alist |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
460 This function works like @code{assoc}, except that @var{key} must be a |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
461 string, and comparison is done using @code{compare-strings}. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
462 Case differences are significant. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
463 @end defun |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
464 |
6550 | 465 See also @code{compare-buffer-substrings} in @ref{Comparing Text}, for |
466 a way to compare text in buffers. The function @code{string-match}, | |
467 which matches a regular expression against a string, can be used | |
468 for a kind of string comparison; see @ref{Regexp Search}. | |
469 | |
470 @node String Conversion | |
471 @comment node-name, next, previous, up | |
472 @section Conversion of Characters and Strings | |
473 @cindex conversion of strings | |
474 | |
475 This section describes functions for conversions between characters, | |
476 strings and integers. @code{format} and @code{prin1-to-string} | |
477 (@pxref{Output Functions}) can also convert Lisp objects into strings. | |
478 @code{read-from-string} (@pxref{Input Functions}) can ``convert'' a | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
479 string representation of a Lisp object into an object. The functions |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
480 @code{string-make-multibyte} and @code{string-make-unibyte} convert the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
481 text representation of a string (@pxref{Converting Representations}). |
6550 | 482 |
483 @xref{Documentation}, for functions that produce textual descriptions | |
484 of text characters and general input events | |
485 (@code{single-key-description} and @code{text-char-description}). These | |
486 functions are used primarily for making help messages. | |
487 | |
488 @defun char-to-string character | |
489 @cindex character to string | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
490 This function returns a new string containing one character, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
491 @var{character}. This function is semi-obsolete because the function |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
492 @code{string} is more general. @xref{Creating Strings}. |
6550 | 493 @end defun |
494 | |
495 @defun string-to-char string | |
496 @cindex string to character | |
497 This function returns the first character in @var{string}. If the | |
498 string is empty, the function returns 0. The value is also 0 when the | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
499 first character of @var{string} is the null character, @sc{ascii} code |
6550 | 500 0. |
501 | |
502 @example | |
503 (string-to-char "ABC") | |
504 @result{} 65 | |
505 (string-to-char "xyz") | |
506 @result{} 120 | |
507 (string-to-char "") | |
508 @result{} 0 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
509 @group |
6550 | 510 (string-to-char "\000") |
511 @result{} 0 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
512 @end group |
6550 | 513 @end example |
514 | |
515 This function may be eliminated in the future if it does not seem useful | |
516 enough to retain. | |
517 @end defun | |
518 | |
519 @defun number-to-string number | |
520 @cindex integer to string | |
521 @cindex integer to decimal | |
24862 | 522 This function returns a string consisting of the printed base-ten |
6550 | 523 representation of @var{number}, which may be an integer or a floating |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
524 point number. The returned value starts with a minus sign if the argument is |
6550 | 525 negative. |
526 | |
527 @example | |
528 (number-to-string 256) | |
529 @result{} "256" | |
530 (number-to-string -23) | |
531 @result{} "-23" | |
532 (number-to-string -23.5) | |
533 @result{} "-23.5" | |
534 @end example | |
535 | |
536 @cindex int-to-string | |
537 @code{int-to-string} is a semi-obsolete alias for this function. | |
538 | |
539 See also the function @code{format} in @ref{Formatting Strings}. | |
540 @end defun | |
541 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
542 @defun string-to-number string &optional base |
6550 | 543 @cindex string to number |
544 This function returns the numeric value of the characters in | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
545 @var{string}. If @var{base} is non-@code{nil}, integers are converted |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
546 in that base. If @var{base} is @code{nil}, then base ten is used. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
547 Floating point conversion always uses base ten; we have not implemented |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
548 other radices for floating point numbers, because that would be much |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
549 more work and does not seem useful. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
550 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
551 The parsing skips spaces and tabs at the beginning of @var{string}, then |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
552 reads as much of @var{string} as it can interpret as a number. (On some |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
553 systems it ignores other whitespace at the beginning, not just spaces |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
554 and tabs.) If the first character after the ignored whitespace is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
555 neither a digit, nor a plus or minus sign, nor the leading dot of a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
556 floating point number, this function returns 0. |
6550 | 557 |
558 @example | |
559 (string-to-number "256") | |
560 @result{} 256 | |
561 (string-to-number "25 is a perfect square.") | |
562 @result{} 25 | |
563 (string-to-number "X256") | |
564 @result{} 0 | |
565 (string-to-number "-4.5") | |
566 @result{} -4.5 | |
567 @end example | |
568 | |
569 @findex string-to-int | |
570 @code{string-to-int} is an obsolete alias for this function. | |
571 @end defun | |
572 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
573 Here are some other functions that can convert to or from a string: |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
574 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
575 @table @code |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
576 @item concat |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
577 @code{concat} can convert a vector or a list into a string. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
578 @xref{Creating Strings}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
579 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
580 @item vconcat |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
581 @code{vconcat} can convert a string into a vector. @xref{Vector |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
582 Functions}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
583 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
584 @item append |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
585 @code{append} can convert a string into a list. @xref{Building Lists}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
586 @end table |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
587 |
6550 | 588 @node Formatting Strings |
589 @comment node-name, next, previous, up | |
590 @section Formatting Strings | |
591 @cindex formatting strings | |
592 @cindex strings, formatting them | |
593 | |
594 @dfn{Formatting} means constructing a string by substitution of | |
24862 | 595 computed values at various places in a constant string. This constant string |
596 controls how the other values are printed, as well as where they appear; | |
6550 | 597 it is called a @dfn{format string}. |
598 | |
599 Formatting is often useful for computing messages to be displayed. In | |
600 fact, the functions @code{message} and @code{error} provide the same | |
601 formatting feature described here; they differ from @code{format} only | |
602 in how they use the result of formatting. | |
603 | |
604 @defun format string &rest objects | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
605 This function returns a new string that is made by copying |
6550 | 606 @var{string} and then replacing any format specification |
607 in the copy with encodings of the corresponding @var{objects}. The | |
608 arguments @var{objects} are the computed values to be formatted. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
609 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
610 The characters in @var{string}, other than the format specifications, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
611 are copied directly into the output; starting in Emacs 21, if they have |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
612 text properties, these are copied into the output also. |
6550 | 613 @end defun |
614 | |
615 @cindex @samp{%} in format | |
616 @cindex format specification | |
617 A format specification is a sequence of characters beginning with a | |
618 @samp{%}. Thus, if there is a @samp{%d} in @var{string}, the | |
619 @code{format} function replaces it with the printed representation of | |
620 one of the values to be formatted (one of the arguments @var{objects}). | |
621 For example: | |
622 | |
623 @example | |
624 @group | |
625 (format "The value of fill-column is %d." fill-column) | |
626 @result{} "The value of fill-column is 72." | |
627 @end group | |
628 @end example | |
629 | |
630 If @var{string} contains more than one format specification, the | |
24862 | 631 format specifications correspond to successive values from |
6550 | 632 @var{objects}. Thus, the first format specification in @var{string} |
633 uses the first such value, the second format specification uses the | |
634 second such value, and so on. Any extra format specifications (those | |
635 for which there are no corresponding values) cause unpredictable | |
636 behavior. Any extra values to be formatted are ignored. | |
637 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
638 Certain format specifications require values of particular types. If |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
639 you supply a value that doesn't fit the requirements, an error is |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
640 signaled. |
6550 | 641 |
642 Here is a table of valid format specifications: | |
643 | |
644 @table @samp | |
645 @item %s | |
646 Replace the specification with the printed representation of the object, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
647 made without quoting (that is, using @code{princ}, not |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
648 @code{prin1}---@pxref{Output Functions}). Thus, strings are represented |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
649 by their contents alone, with no @samp{"} characters, and symbols appear |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
650 without @samp{\} characters. |
6550 | 651 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
652 Starting in Emacs 21, if the object is a string, its text properties are |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
653 copied into the output. The text properties of the @samp{%s} itself |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
654 are also copied, but those of the object take priority. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
655 |
6550 | 656 If there is no corresponding object, the empty string is used. |
657 | |
658 @item %S | |
659 Replace the specification with the printed representation of the object, | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
660 made with quoting (that is, using @code{prin1}---@pxref{Output |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
661 Functions}). Thus, strings are enclosed in @samp{"} characters, and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
662 @samp{\} characters appear where necessary before special characters. |
6550 | 663 |
664 If there is no corresponding object, the empty string is used. | |
665 | |
666 @item %o | |
667 @cindex integer to octal | |
668 Replace the specification with the base-eight representation of an | |
669 integer. | |
670 | |
671 @item %d | |
672 Replace the specification with the base-ten representation of an | |
673 integer. | |
674 | |
675 @item %x | |
676 @cindex integer to hexadecimal | |
677 Replace the specification with the base-sixteen representation of an | |
678 integer. | |
679 | |
680 @item %c | |
681 Replace the specification with the character which is the value given. | |
682 | |
683 @item %e | |
684 Replace the specification with the exponential notation for a floating | |
685 point number. | |
686 | |
687 @item %f | |
688 Replace the specification with the decimal-point notation for a floating | |
689 point number. | |
690 | |
691 @item %g | |
692 Replace the specification with notation for a floating point number, | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
693 using either exponential notation or decimal-point notation, whichever |
6550 | 694 is shorter. |
695 | |
696 @item %% | |
24862 | 697 Replace the specification with a single @samp{%}. This format specification is |
6550 | 698 unusual in that it does not use a value. For example, @code{(format "%% |
699 %d" 30)} returns @code{"% 30"}. | |
700 @end table | |
701 | |
702 Any other format character results in an @samp{Invalid format | |
703 operation} error. | |
704 | |
705 Here are several examples: | |
706 | |
707 @example | |
708 @group | |
709 (format "The name of this buffer is %s." (buffer-name)) | |
710 @result{} "The name of this buffer is strings.texi." | |
711 | |
712 (format "The buffer object prints as %s." (current-buffer)) | |
13228 | 713 @result{} "The buffer object prints as strings.texi." |
6550 | 714 |
715 (format "The octal value of %d is %o, | |
716 and the hex value is %x." 18 18 18) | |
717 @result{} "The octal value of 18 is 22, | |
718 and the hex value is 12." | |
719 @end group | |
720 @end example | |
721 | |
722 @cindex numeric prefix | |
723 @cindex field width | |
724 @cindex padding | |
725 All the specification characters allow an optional numeric prefix | |
726 between the @samp{%} and the character. The optional numeric prefix | |
727 defines the minimum width for the object. If the printed representation | |
728 of the object contains fewer characters than this, then it is padded. | |
729 The padding is on the left if the prefix is positive (or starts with | |
730 zero) and on the right if the prefix is negative. The padding character | |
731 is normally a space, but if the numeric prefix starts with a zero, zeros | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
732 are used for padding. Here are some examples of padding: |
6550 | 733 |
734 @example | |
735 (format "%06d is padded on the left with zeros" 123) | |
736 @result{} "000123 is padded on the left with zeros" | |
737 | |
738 (format "%-6d is padded on the right" 123) | |
739 @result{} "123 is padded on the right" | |
740 @end example | |
741 | |
742 @code{format} never truncates an object's printed representation, no | |
743 matter what width you specify. Thus, you can use a numeric prefix to | |
744 specify a minimum spacing between columns with no risk of losing | |
745 information. | |
746 | |
747 In the following three examples, @samp{%7s} specifies a minimum width | |
748 of 7. In the first case, the string inserted in place of @samp{%7s} has | |
749 only 3 letters, so 4 blank spaces are inserted for padding. In the | |
750 second case, the string @code{"specification"} is 13 letters wide but is | |
751 not truncated. In the third case, the padding is on the right. | |
752 | |
753 @smallexample | |
754 @group | |
755 (format "The word `%7s' actually has %d letters in it." | |
756 "foo" (length "foo")) | |
757 @result{} "The word ` foo' actually has 3 letters in it." | |
758 @end group | |
759 | |
760 @group | |
761 (format "The word `%7s' actually has %d letters in it." | |
762 "specification" (length "specification")) | |
763 @result{} "The word `specification' actually has 13 letters in it." | |
764 @end group | |
765 | |
766 @group | |
767 (format "The word `%-7s' actually has %d letters in it." | |
768 "foo" (length "foo")) | |
769 @result{} "The word `foo ' actually has 3 letters in it." | |
770 @end group | |
771 @end smallexample | |
772 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
773 @node Case Conversion |
6550 | 774 @comment node-name, next, previous, up |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
775 @section Case Conversion in Lisp |
6550 | 776 @cindex upper case |
777 @cindex lower case | |
778 @cindex character case | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
779 @cindex case conversion in Lisp |
6550 | 780 |
781 The character case functions change the case of single characters or | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
782 of the contents of strings. The functions normally convert only |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
783 alphabetic characters (the letters @samp{A} through @samp{Z} and |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
784 @samp{a} through @samp{z}, as well as non-@sc{ascii} letters); other |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
785 characters are not altered. You can specify a different case |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
786 conversion mapping by specifying a case table (@pxref{Case Tables}). |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
787 |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
788 These functions do not modify the strings that are passed to them as |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
789 arguments. |
6550 | 790 |
791 The examples below use the characters @samp{X} and @samp{x} which have | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
792 @sc{ascii} codes 88 and 120 respectively. |
6550 | 793 |
794 @defun downcase string-or-char | |
795 This function converts a character or a string to lower case. | |
796 | |
797 When the argument to @code{downcase} is a string, the function creates | |
798 and returns a new string in which each letter in the argument that is | |
799 upper case is converted to lower case. When the argument to | |
800 @code{downcase} is a character, @code{downcase} returns the | |
801 corresponding lower case character. This value is an integer. If the | |
802 original character is lower case, or is not a letter, then the value | |
803 equals the original character. | |
804 | |
805 @example | |
806 (downcase "The cat in the hat") | |
807 @result{} "the cat in the hat" | |
808 | |
809 (downcase ?X) | |
810 @result{} 120 | |
811 @end example | |
812 @end defun | |
813 | |
814 @defun upcase string-or-char | |
815 This function converts a character or a string to upper case. | |
816 | |
817 When the argument to @code{upcase} is a string, the function creates | |
818 and returns a new string in which each letter in the argument that is | |
819 lower case is converted to upper case. | |
820 | |
821 When the argument to @code{upcase} is a character, @code{upcase} | |
822 returns the corresponding upper case character. This value is an integer. | |
823 If the original character is upper case, or is not a letter, then the | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
824 value returned equals the original character. |
6550 | 825 |
826 @example | |
827 (upcase "The cat in the hat") | |
828 @result{} "THE CAT IN THE HAT" | |
829 | |
830 (upcase ?x) | |
831 @result{} 88 | |
832 @end example | |
833 @end defun | |
834 | |
835 @defun capitalize string-or-char | |
836 @cindex capitalization | |
837 This function capitalizes strings or characters. If | |
838 @var{string-or-char} is a string, the function creates and returns a new | |
839 string, whose contents are a copy of @var{string-or-char} in which each | |
840 word has been capitalized. This means that the first character of each | |
841 word is converted to upper case, and the rest are converted to lower | |
842 case. | |
843 | |
844 The definition of a word is any sequence of consecutive characters that | |
845 are assigned to the word constituent syntax class in the current syntax | |
25454 | 846 table (@pxref{Syntax Class Table}). |
6550 | 847 |
848 When the argument to @code{capitalize} is a character, @code{capitalize} | |
849 has the same result as @code{upcase}. | |
850 | |
851 @example | |
852 (capitalize "The cat in the hat") | |
853 @result{} "The Cat In The Hat" | |
854 | |
855 (capitalize "THE 77TH-HATTED CAT") | |
856 @result{} "The 77th-Hatted Cat" | |
857 | |
858 @group | |
859 (capitalize ?x) | |
860 @result{} 88 | |
861 @end group | |
862 @end example | |
863 @end defun | |
864 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
865 @defun upcase-initials string |
24862 | 866 This function capitalizes the initials of the words in @var{string}, |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
867 without altering any letters other than the initials. It returns a new |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
868 string whose contents are a copy of @var{string}, in which each word has |
24862 | 869 had its initial letter converted to upper case. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
870 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
871 The definition of a word is any sequence of consecutive characters that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
872 are assigned to the word constituent syntax class in the current syntax |
25454 | 873 table (@pxref{Syntax Class Table}). |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
874 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
875 @example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
876 @group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
877 (upcase-initials "The CAT in the hAt") |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
878 @result{} "The CAT In The HAt" |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
879 @end group |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
880 @end example |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
881 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
882 |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
883 @xref{Text Comparison}, for functions that compare strings; some of |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
884 them ignore case differences, or can optionally ignore case differences. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
885 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
886 @node Case Tables |
6550 | 887 @section The Case Table |
888 | |
889 You can customize case conversion by installing a special @dfn{case | |
890 table}. A case table specifies the mapping between upper case and lower | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
891 case letters. It affects both the case conversion functions for Lisp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
892 objects (see the previous section) and those that apply to text in the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
893 buffer (@pxref{Case Changes}). Each buffer has a case table; there is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
894 also a standard case table which is used to initialize the case table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
895 of new buffers. |
6550 | 896 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
897 A case table is a char-table (@pxref{Char-Tables}) whose subtype is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
898 @code{case-table}. This char-table maps each character into the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
899 corresponding lower case character. It has three extra slots, which |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
900 hold related tables: |
6550 | 901 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
902 @table @var |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
903 @item upcase |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
904 The upcase table maps each character into the corresponding upper |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
905 case character. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
906 @item canonicalize |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
907 The canonicalize table maps all of a set of case-related characters |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
908 into a particular member of that set. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
909 @item equivalences |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
910 The equivalences table maps each one of a set of case-related characters |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
911 into the next character in that set. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
912 @end table |
6550 | 913 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
914 In simple cases, all you need to specify is the mapping to lower-case; |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
915 the three related tables will be calculated automatically from that one. |
6550 | 916 |
917 For some languages, upper and lower case letters are not in one-to-one | |
918 correspondence. There may be two different lower case letters with the | |
919 same upper case equivalent. In these cases, you need to specify the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
920 maps for both lower case and upper case. |
6550 | 921 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
922 The extra table @var{canonicalize} maps each character to a canonical |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
923 equivalent; any two characters that are related by case-conversion have |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
924 the same canonical equivalent character. For example, since @samp{a} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
925 and @samp{A} are related by case-conversion, they should have the same |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
926 canonical equivalent character (which should be either @samp{a} for both |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
927 of them, or @samp{A} for both of them). |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
928 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
929 The extra table @var{equivalences} is a map that cyclicly permutes |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
930 each equivalence class (of characters with the same canonical |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
931 equivalent). (For ordinary @sc{ascii}, this would map @samp{a} into |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
932 @samp{A} and @samp{A} into @samp{a}, and likewise for each set of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
933 equivalent characters.) |
6550 | 934 |
6938
782646fc7505
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6550
diff
changeset
|
935 When you construct a case table, you can provide @code{nil} for |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
936 @var{canonicalize}; then Emacs fills in this slot from the lower case |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
937 and upper case mappings. You can also provide @code{nil} for |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
938 @var{equivalences}; then Emacs fills in this slot from |
6938
782646fc7505
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6550
diff
changeset
|
939 @var{canonicalize}. In a case table that is actually in use, those |
782646fc7505
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6550
diff
changeset
|
940 components are non-@code{nil}. Do not try to specify @var{equivalences} |
782646fc7505
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
6550
diff
changeset
|
941 without also specifying @var{canonicalize}. |
6550 | 942 |
943 Here are the functions for working with case tables: | |
944 | |
945 @defun case-table-p object | |
946 This predicate returns non-@code{nil} if @var{object} is a valid case | |
947 table. | |
948 @end defun | |
949 | |
950 @defun set-standard-case-table table | |
951 This function makes @var{table} the standard case table, so that it will | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
952 be used in any buffers created subsequently. |
6550 | 953 @end defun |
954 | |
955 @defun standard-case-table | |
956 This returns the standard case table. | |
957 @end defun | |
958 | |
959 @defun current-case-table | |
960 This function returns the current buffer's case table. | |
961 @end defun | |
962 | |
963 @defun set-case-table table | |
964 This sets the current buffer's case table to @var{table}. | |
965 @end defun | |
966 | |
967 The following three functions are convenient subroutines for packages | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25454
diff
changeset
|
968 that define non-@sc{ascii} character sets. They modify the specified |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
969 case table @var{case-table}; they also modify the standard syntax table. |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
970 @xref{Syntax Tables}. Normally you would use these functions to change |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
971 the standard case table. |
6550 | 972 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
973 @defun set-case-syntax-pair uc lc case-table |
6550 | 974 This function specifies a pair of corresponding letters, one upper case |
975 and one lower case. | |
976 @end defun | |
977 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
978 @defun set-case-syntax-delims l r case-table |
6550 | 979 This function makes characters @var{l} and @var{r} a matching pair of |
980 case-invariant delimiters. | |
981 @end defun | |
982 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
13228
diff
changeset
|
983 @defun set-case-syntax char syntax case-table |
6550 | 984 This function makes @var{char} case-invariant, with syntax |
985 @var{syntax}. | |
986 @end defun | |
987 | |
988 @deffn Command describe-buffer-case-table | |
989 This command displays a description of the contents of the current | |
990 buffer's case table. | |
991 @end deffn |