Commit | Line | Data |
---|---|---|
b8d4c8d0 GM |
1 | @c -*-texinfo-*- |
2 | @c This is part of the GNU Emacs Lisp Reference Manual. | |
acaf905b | 3 | @c Copyright (C) 1990-1995, 1998-1999, 2001-2012 |
d24880de | 4 | @c Free Software Foundation, Inc. |
b8d4c8d0 | 5 | @c See the file elisp.texi for copying conditions. |
b8d4c8d0 GM |
6 | @node Strings and Characters, Lists, Numbers, Top |
7 | @comment node-name, next, previous, up | |
8 | @chapter Strings and Characters | |
9 | @cindex strings | |
10 | @cindex character arrays | |
11 | @cindex characters | |
12 | @cindex bytes | |
13 | ||
14 | A string in Emacs Lisp is an array that contains an ordered sequence | |
15 | of characters. Strings are used as names of symbols, buffers, and | |
16 | files; to send messages to users; to hold text being copied between | |
17 | buffers; and for many other purposes. Because strings are so important, | |
18 | Emacs Lisp has many functions expressly for manipulating them. Emacs | |
19 | Lisp programs use strings more often than individual characters. | |
20 | ||
21 | @xref{Strings of Events}, for special considerations for strings of | |
22 | keyboard character events. | |
23 | ||
24 | @menu | |
25 | * Basics: String Basics. Basic properties of strings and characters. | |
26 | * Predicates for Strings:: Testing whether an object is a string or char. | |
27 | * Creating Strings:: Functions to allocate new strings. | |
28 | * Modifying Strings:: Altering the contents of an existing string. | |
29 | * Text Comparison:: Comparing characters or strings. | |
30 | * String Conversion:: Converting to and from characters and strings. | |
31 | * Formatting Strings:: @code{format}: Emacs's analogue of @code{printf}. | |
32 | * Case Conversion:: Case conversion functions. | |
d24880de | 33 | * Case Tables:: Customizing case conversion. |
b8d4c8d0 GM |
34 | @end menu |
35 | ||
36 | @node String Basics | |
37 | @section String and Character Basics | |
38 | ||
39 | Characters are represented in Emacs Lisp as integers; | |
40 | whether an integer is a character or not is determined only by how it is | |
b5173574 EZ |
41 | used. Thus, strings really contain integers. @xref{Character Codes}, |
42 | for details about character representation in Emacs. | |
b8d4c8d0 GM |
43 | |
44 | The length of a string (like any array) is fixed, and cannot be | |
45 | altered once the string exists. Strings in Lisp are @emph{not} | |
46 | terminated by a distinguished character code. (By contrast, strings in | |
47 | C are terminated by a character with @acronym{ASCII} code 0.) | |
48 | ||
49 | Since strings are arrays, and therefore sequences as well, you can | |
50 | operate on them with the general array and sequence functions. | |
51 | (@xref{Sequences Arrays Vectors}.) For example, you can access or | |
52 | change individual characters in a string using the functions @code{aref} | |
83a96c08 EZ |
53 | and @code{aset} (@pxref{Array Functions}). However, note that |
54 | @code{length} should @emph{not} be used for computing the width of a | |
55 | string on display; use @code{string-width} (@pxref{Width}) instead. | |
b8d4c8d0 GM |
56 | |
57 | There are two text representations for non-@acronym{ASCII} characters in | |
58 | Emacs strings (and in buffers): unibyte and multibyte (@pxref{Text | |
b5173574 EZ |
59 | Representations}). For most Lisp programming, you don't need to be |
60 | concerned with these two representations. | |
b8d4c8d0 | 61 | |
5dedd9b5 EZ |
62 | Sometimes key sequences are represented as unibyte strings. When a |
63 | unibyte string is a key sequence, string elements in the range 128 to | |
64 | 255 represent meta characters (which are large integers) rather than | |
8f88eb24 CY |
65 | character codes in the range 128 to 255. Strings cannot hold |
66 | characters that have the hyper, super or alt modifiers; they can hold | |
67 | @acronym{ASCII} control characters, but no other control characters. | |
68 | They do not distinguish case in @acronym{ASCII} control characters. | |
69 | If you want to store such characters in a sequence, such as a key | |
70 | sequence, you must use a vector instead of a string. @xref{Character | |
71 | Type}, for more information about keyboard input characters. | |
b8d4c8d0 GM |
72 | |
73 | Strings are useful for holding regular expressions. You can also | |
74 | match regular expressions against strings with @code{string-match} | |
75 | (@pxref{Regexp Search}). The functions @code{match-string} | |
76 | (@pxref{Simple Match Data}) and @code{replace-match} (@pxref{Replacing | |
77 | Match}) are useful for decomposing and modifying strings after | |
78 | matching regular expressions against them. | |
79 | ||
80 | Like a buffer, a string can contain text properties for the characters | |
81 | in it, as well as the characters themselves. @xref{Text Properties}. | |
82 | All the Lisp primitives that copy text from strings to buffers or other | |
83 | strings also copy the properties of the characters being copied. | |
84 | ||
85 | @xref{Text}, for information about functions that display strings or | |
86 | copy them into buffers. @xref{Character Type}, and @ref{String Type}, | |
87 | for information about the syntax of characters and strings. | |
88 | @xref{Non-ASCII Characters}, for functions to convert between text | |
89 | representations and to encode and decode character codes. | |
90 | ||
91 | @node Predicates for Strings | |
92 | @section The Predicates for Strings | |
93 | ||
94 | For more information about general sequence and array predicates, | |
95 | see @ref{Sequences Arrays Vectors}, and @ref{Arrays}. | |
96 | ||
97 | @defun stringp object | |
98 | This function returns @code{t} if @var{object} is a string, @code{nil} | |
99 | otherwise. | |
100 | @end defun | |
101 | ||
102 | @defun string-or-null-p object | |
8c641f06 | 103 | This function returns @code{t} if @var{object} is a string or |
638a2457 | 104 | @code{nil}. It returns @code{nil} otherwise. |
b8d4c8d0 GM |
105 | @end defun |
106 | ||
107 | @defun char-or-string-p object | |
108 | This function returns @code{t} if @var{object} is a string or a | |
109 | character (i.e., an integer), @code{nil} otherwise. | |
110 | @end defun | |
111 | ||
112 | @node Creating Strings | |
113 | @section Creating Strings | |
114 | ||
115 | The following functions create strings, either from scratch, or by | |
116 | putting strings together, or by taking them apart. | |
117 | ||
118 | @defun make-string count character | |
119 | This function returns a string made up of @var{count} repetitions of | |
120 | @var{character}. If @var{count} is negative, an error is signaled. | |
121 | ||
122 | @example | |
123 | (make-string 5 ?x) | |
124 | @result{} "xxxxx" | |
125 | (make-string 0 ?x) | |
126 | @result{} "" | |
127 | @end example | |
128 | ||
3e99b825 CY |
129 | Other functions to compare with this one include @code{make-vector} |
130 | (@pxref{Vectors}) and @code{make-list} (@pxref{Building Lists}). | |
b8d4c8d0 GM |
131 | @end defun |
132 | ||
133 | @defun string &rest characters | |
134 | This returns a string containing the characters @var{characters}. | |
135 | ||
136 | @example | |
137 | (string ?a ?b ?c) | |
138 | @result{} "abc" | |
139 | @end example | |
140 | @end defun | |
141 | ||
142 | @defun substring string start &optional end | |
143 | This function returns a new string which consists of those characters | |
144 | from @var{string} in the range from (and including) the character at the | |
145 | index @var{start} up to (but excluding) the character at the index | |
146 | @var{end}. The first character is at index zero. | |
147 | ||
148 | @example | |
149 | @group | |
150 | (substring "abcdefg" 0 3) | |
151 | @result{} "abc" | |
152 | @end group | |
153 | @end example | |
154 | ||
155 | @noindent | |
8f88eb24 CY |
156 | In the above example, the index for @samp{a} is 0, the index for |
157 | @samp{b} is 1, and the index for @samp{c} is 2. The index 3---which | |
a86cd395 JB |
158 | is the fourth character in the string---marks the character position |
159 | up to which the substring is copied. Thus, @samp{abc} is copied from | |
160 | the string @code{"abcdefg"}. | |
b8d4c8d0 GM |
161 | |
162 | A negative number counts from the end of the string, so that @minus{}1 | |
163 | signifies the index of the last character of the string. For example: | |
164 | ||
165 | @example | |
166 | @group | |
167 | (substring "abcdefg" -3 -1) | |
168 | @result{} "ef" | |
169 | @end group | |
170 | @end example | |
171 | ||
172 | @noindent | |
173 | In this example, the index for @samp{e} is @minus{}3, the index for | |
174 | @samp{f} is @minus{}2, and the index for @samp{g} is @minus{}1. | |
175 | Therefore, @samp{e} and @samp{f} are included, and @samp{g} is excluded. | |
176 | ||
177 | When @code{nil} is used for @var{end}, it stands for the length of the | |
178 | string. Thus, | |
179 | ||
180 | @example | |
181 | @group | |
182 | (substring "abcdefg" -3 nil) | |
183 | @result{} "efg" | |
184 | @end group | |
185 | @end example | |
186 | ||
187 | Omitting the argument @var{end} is equivalent to specifying @code{nil}. | |
188 | It follows that @code{(substring @var{string} 0)} returns a copy of all | |
189 | of @var{string}. | |
190 | ||
191 | @example | |
192 | @group | |
193 | (substring "abcdefg" 0) | |
194 | @result{} "abcdefg" | |
195 | @end group | |
196 | @end example | |
197 | ||
198 | @noindent | |
199 | But we recommend @code{copy-sequence} for this purpose (@pxref{Sequence | |
200 | Functions}). | |
201 | ||
202 | If the characters copied from @var{string} have text properties, the | |
203 | properties are copied into the new string also. @xref{Text Properties}. | |
204 | ||
205 | @code{substring} also accepts a vector for the first argument. | |
206 | For example: | |
207 | ||
208 | @example | |
209 | (substring [a b (c) "d"] 1 3) | |
210 | @result{} [b (c)] | |
211 | @end example | |
212 | ||
213 | A @code{wrong-type-argument} error is signaled if @var{start} is not | |
214 | an integer or if @var{end} is neither an integer nor @code{nil}. An | |
215 | @code{args-out-of-range} error is signaled if @var{start} indicates a | |
216 | character following @var{end}, or if either integer is out of range | |
217 | for @var{string}. | |
218 | ||
219 | Contrast this function with @code{buffer-substring} (@pxref{Buffer | |
220 | Contents}), which returns a string containing a portion of the text in | |
221 | the current buffer. The beginning of a string is at index 0, but the | |
222 | beginning of a buffer is at index 1. | |
223 | @end defun | |
224 | ||
225 | @defun substring-no-properties string &optional start end | |
226 | This works like @code{substring} but discards all text properties from | |
227 | the value. Also, @var{start} may be omitted or @code{nil}, which is | |
228 | equivalent to 0. Thus, @w{@code{(substring-no-properties | |
229 | @var{string})}} returns a copy of @var{string}, with all text | |
230 | properties removed. | |
231 | @end defun | |
232 | ||
233 | @defun concat &rest sequences | |
234 | @cindex copying strings | |
235 | @cindex concatenating strings | |
236 | This function returns a new string consisting of the characters in the | |
237 | arguments passed to it (along with their text properties, if any). The | |
238 | arguments may be strings, lists of numbers, or vectors of numbers; they | |
239 | are not themselves changed. If @code{concat} receives no arguments, it | |
240 | returns an empty string. | |
241 | ||
242 | @example | |
243 | (concat "abc" "-def") | |
244 | @result{} "abc-def" | |
245 | (concat "abc" (list 120 121) [122]) | |
246 | @result{} "abcxyz" | |
247 | ;; @r{@code{nil} is an empty sequence.} | |
248 | (concat "abc" nil "-def") | |
249 | @result{} "abc-def" | |
250 | (concat "The " "quick brown " "fox.") | |
251 | @result{} "The quick brown fox." | |
252 | (concat) | |
253 | @result{} "" | |
254 | @end example | |
255 | ||
256 | @noindent | |
8f88eb24 CY |
257 | This function always constructs a new string that is not @code{eq} to |
258 | any existing string, except when the result is the empty string (to | |
259 | save space, Emacs makes only one empty multibyte string). | |
b8d4c8d0 GM |
260 | |
261 | For information about other concatenation functions, see the | |
262 | description of @code{mapconcat} in @ref{Mapping Functions}, | |
263 | @code{vconcat} in @ref{Vector Functions}, and @code{append} in @ref{Building | |
fd6f900c EZ |
264 | Lists}. For concatenating individual command-line arguments into a |
265 | string to be used as a shell command, see @ref{Shell Arguments, | |
266 | combine-and-quote-strings}. | |
b8d4c8d0 GM |
267 | @end defun |
268 | ||
269 | @defun split-string string &optional separators omit-nulls | |
8f88eb24 CY |
270 | This function splits @var{string} into substrings based on the regular |
271 | expression @var{separators} (@pxref{Regular Expressions}). Each match | |
272 | for @var{separators} defines a splitting point; the substrings between | |
273 | splitting points are made into a list, which is returned. | |
b8d4c8d0 | 274 | |
8f88eb24 CY |
275 | If @var{omit-nulls} is @code{nil} (or omitted), the result contains |
276 | null strings whenever there are two consecutive matches for | |
277 | @var{separators}, or a match is adjacent to the beginning or end of | |
278 | @var{string}. If @var{omit-nulls} is @code{t}, these null strings are | |
279 | omitted from the result. | |
b8d4c8d0 | 280 | |
8f88eb24 CY |
281 | If @var{separators} is @code{nil} (or omitted), the default is the |
282 | value of @code{split-string-default-separators}. | |
b8d4c8d0 GM |
283 | |
284 | As a special case, when @var{separators} is @code{nil} (or omitted), | |
285 | null strings are always omitted from the result. Thus: | |
286 | ||
287 | @example | |
288 | (split-string " two words ") | |
289 | @result{} ("two" "words") | |
290 | @end example | |
291 | ||
292 | The result is not @code{("" "two" "words" "")}, which would rarely be | |
293 | useful. If you need such a result, use an explicit value for | |
294 | @var{separators}: | |
295 | ||
296 | @example | |
297 | (split-string " two words " | |
298 | split-string-default-separators) | |
299 | @result{} ("" "two" "words" "") | |
300 | @end example | |
301 | ||
302 | More examples: | |
303 | ||
304 | @example | |
305 | (split-string "Soup is good food" "o") | |
306 | @result{} ("S" "up is g" "" "d f" "" "d") | |
307 | (split-string "Soup is good food" "o" t) | |
308 | @result{} ("S" "up is g" "d f" "d") | |
309 | (split-string "Soup is good food" "o+") | |
310 | @result{} ("S" "up is g" "d f" "d") | |
311 | @end example | |
312 | ||
313 | Empty matches do count, except that @code{split-string} will not look | |
314 | for a final empty match when it already reached the end of the string | |
315 | using a non-empty match or when @var{string} is empty: | |
316 | ||
317 | @example | |
318 | (split-string "aooob" "o*") | |
319 | @result{} ("" "a" "" "b" "") | |
320 | (split-string "ooaboo" "o*") | |
321 | @result{} ("" "" "a" "b" "") | |
322 | (split-string "" "") | |
323 | @result{} ("") | |
324 | @end example | |
325 | ||
326 | However, when @var{separators} can match the empty string, | |
327 | @var{omit-nulls} is usually @code{t}, so that the subtleties in the | |
328 | three previous examples are rarely relevant: | |
329 | ||
330 | @example | |
331 | (split-string "Soup is good food" "o*" t) | |
332 | @result{} ("S" "u" "p" " " "i" "s" " " "g" "d" " " "f" "d") | |
333 | (split-string "Nice doggy!" "" t) | |
334 | @result{} ("N" "i" "c" "e" " " "d" "o" "g" "g" "y" "!") | |
335 | (split-string "" "" t) | |
336 | @result{} nil | |
337 | @end example | |
338 | ||
339 | Somewhat odd, but predictable, behavior can occur for certain | |
340 | ``non-greedy'' values of @var{separators} that can prefer empty | |
341 | matches over non-empty matches. Again, such values rarely occur in | |
342 | practice: | |
343 | ||
344 | @example | |
345 | (split-string "ooo" "o*" t) | |
346 | @result{} nil | |
347 | (split-string "ooo" "\\|o+" t) | |
348 | @result{} ("o" "o" "o") | |
349 | @end example | |
fd6f900c | 350 | |
4bb49a92 EZ |
351 | If you need to split a string into a list of individual command-line |
352 | arguments suitable for @code{call-process} or @code{start-process}, | |
353 | see @ref{Shell Arguments, split-string-and-unquote}. | |
b8d4c8d0 GM |
354 | @end defun |
355 | ||
356 | @defvar split-string-default-separators | |
357 | The default value of @var{separators} for @code{split-string}. Its | |
358 | usual value is @w{@code{"[ \f\t\n\r\v]+"}}. | |
359 | @end defvar | |
360 | ||
361 | @node Modifying Strings | |
362 | @section Modifying Strings | |
363 | ||
364 | The most basic way to alter the contents of an existing string is with | |
365 | @code{aset} (@pxref{Array Functions}). @code{(aset @var{string} | |
366 | @var{idx} @var{char})} stores @var{char} into @var{string} at index | |
367 | @var{idx}. Each character occupies one or more bytes, and if @var{char} | |
368 | needs a different number of bytes from the character already present at | |
369 | that index, @code{aset} signals an error. | |
370 | ||
371 | A more powerful function is @code{store-substring}: | |
372 | ||
373 | @defun store-substring string idx obj | |
374 | This function alters part of the contents of the string @var{string}, by | |
375 | storing @var{obj} starting at index @var{idx}. The argument @var{obj} | |
376 | may be either a character or a (smaller) string. | |
377 | ||
378 | Since it is impossible to change the length of an existing string, it is | |
379 | an error if @var{obj} doesn't fit within @var{string}'s actual length, | |
380 | or if any new character requires a different number of bytes from the | |
381 | character currently present at that point in @var{string}. | |
382 | @end defun | |
383 | ||
384 | To clear out a string that contained a password, use | |
385 | @code{clear-string}: | |
386 | ||
387 | @defun clear-string string | |
388 | This makes @var{string} a unibyte string and clears its contents to | |
389 | zeros. It may also change @var{string}'s length. | |
390 | @end defun | |
391 | ||
392 | @need 2000 | |
393 | @node Text Comparison | |
394 | @section Comparison of Characters and Strings | |
395 | @cindex string equality | |
396 | ||
397 | @defun char-equal character1 character2 | |
398 | This function returns @code{t} if the arguments represent the same | |
399 | character, @code{nil} otherwise. This function ignores differences | |
400 | in case if @code{case-fold-search} is non-@code{nil}. | |
401 | ||
402 | @example | |
403 | (char-equal ?x ?x) | |
404 | @result{} t | |
405 | (let ((case-fold-search nil)) | |
406 | (char-equal ?x ?X)) | |
407 | @result{} nil | |
408 | @end example | |
409 | @end defun | |
410 | ||
411 | @defun string= string1 string2 | |
412 | This function returns @code{t} if the characters of the two strings | |
413 | match exactly. Symbols are also allowed as arguments, in which case | |
31cbea1d CY |
414 | the symbol names are used. Case is always significant, regardless of |
415 | @code{case-fold-search}. | |
416 | ||
417 | This function is equivalent to @code{equal} for comparing two strings | |
418 | (@pxref{Equality Predicates}). In particular, the text properties of | |
419 | the two strings are ignored. But if either argument is not a string | |
420 | or symbol, an error is signaled. | |
b8d4c8d0 GM |
421 | |
422 | @example | |
423 | (string= "abc" "abc") | |
424 | @result{} t | |
425 | (string= "abc" "ABC") | |
426 | @result{} nil | |
427 | (string= "ab" "ABC") | |
428 | @result{} nil | |
429 | @end example | |
430 | ||
b8d4c8d0 GM |
431 | For technical reasons, a unibyte and a multibyte string are |
432 | @code{equal} if and only if they contain the same sequence of | |
433 | character codes and all these codes are either in the range 0 through | |
434 | 127 (@acronym{ASCII}) or 160 through 255 (@code{eight-bit-graphic}). | |
8f88eb24 CY |
435 | However, when a unibyte string is converted to a multibyte string, all |
436 | characters with codes in the range 160 through 255 are converted to | |
437 | characters with higher codes, whereas @acronym{ASCII} characters | |
b8d4c8d0 GM |
438 | remain unchanged. Thus, a unibyte string and its conversion to |
439 | multibyte are only @code{equal} if the string is all @acronym{ASCII}. | |
440 | Character codes 160 through 255 are not entirely proper in multibyte | |
441 | text, even though they can occur. As a consequence, the situation | |
442 | where a unibyte and a multibyte string are @code{equal} without both | |
443 | being all @acronym{ASCII} is a technical oddity that very few Emacs | |
444 | Lisp programmers ever get confronted with. @xref{Text | |
445 | Representations}. | |
446 | @end defun | |
447 | ||
448 | @defun string-equal string1 string2 | |
449 | @code{string-equal} is another name for @code{string=}. | |
450 | @end defun | |
451 | ||
452 | @cindex lexical comparison | |
453 | @defun string< string1 string2 | |
454 | @c (findex string< causes problems for permuted index!!) | |
455 | This function compares two strings a character at a time. It | |
456 | scans both the strings at the same time to find the first pair of corresponding | |
457 | characters that do not match. If the lesser character of these two is | |
458 | the character from @var{string1}, then @var{string1} is less, and this | |
459 | function returns @code{t}. If the lesser character is the one from | |
460 | @var{string2}, then @var{string1} is greater, and this function returns | |
461 | @code{nil}. If the two strings match entirely, the value is @code{nil}. | |
462 | ||
463 | Pairs of characters are compared according to their character codes. | |
464 | Keep in mind that lower case letters have higher numeric values in the | |
465 | @acronym{ASCII} character set than their upper case counterparts; digits and | |
466 | many punctuation characters have a lower numeric value than upper case | |
467 | letters. An @acronym{ASCII} character is less than any non-@acronym{ASCII} | |
468 | character; a unibyte non-@acronym{ASCII} character is always less than any | |
469 | multibyte non-@acronym{ASCII} character (@pxref{Text Representations}). | |
470 | ||
471 | @example | |
472 | @group | |
473 | (string< "abc" "abd") | |
474 | @result{} t | |
475 | (string< "abd" "abc") | |
476 | @result{} nil | |
477 | (string< "123" "abc") | |
478 | @result{} t | |
479 | @end group | |
480 | @end example | |
481 | ||
482 | When the strings have different lengths, and they match up to the | |
483 | length of @var{string1}, then the result is @code{t}. If they match up | |
484 | to the length of @var{string2}, the result is @code{nil}. A string of | |
485 | no characters is less than any other string. | |
486 | ||
487 | @example | |
488 | @group | |
489 | (string< "" "abc") | |
490 | @result{} t | |
491 | (string< "ab" "abc") | |
492 | @result{} t | |
493 | (string< "abc" "") | |
494 | @result{} nil | |
495 | (string< "abc" "ab") | |
496 | @result{} nil | |
497 | (string< "" "") | |
498 | @result{} nil | |
499 | @end group | |
500 | @end example | |
501 | ||
502 | Symbols are also allowed as arguments, in which case their print names | |
503 | are used. | |
504 | @end defun | |
505 | ||
506 | @defun string-lessp string1 string2 | |
507 | @code{string-lessp} is another name for @code{string<}. | |
508 | @end defun | |
509 | ||
c8f6ec5c GM |
510 | @defun string-prefix-p string1 string2 &optional ignore-case |
511 | This function returns non-@code{nil} if @var{string1} is a prefix of | |
512 | @var{string2}; i.e., if @var{string2} starts with @var{string1}. If | |
513 | the optional argument @var{ignore-case} is non-@code{nil}, the | |
514 | comparison ignores case differences. | |
515 | @end defun | |
516 | ||
b8d4c8d0 GM |
517 | @defun compare-strings string1 start1 end1 string2 start2 end2 &optional ignore-case |
518 | This function compares the specified part of @var{string1} with the | |
519 | specified part of @var{string2}. The specified part of @var{string1} | |
520 | runs from index @var{start1} up to index @var{end1} (@code{nil} means | |
521 | the end of the string). The specified part of @var{string2} runs from | |
522 | index @var{start2} up to index @var{end2} (@code{nil} means the end of | |
523 | the string). | |
524 | ||
525 | The strings are both converted to multibyte for the comparison | |
526 | (@pxref{Text Representations}) so that a unibyte string and its | |
527 | conversion to multibyte are always regarded as equal. If | |
528 | @var{ignore-case} is non-@code{nil}, then case is ignored, so that | |
529 | upper case letters can be equal to lower case letters. | |
530 | ||
531 | If the specified portions of the two strings match, the value is | |
532 | @code{t}. Otherwise, the value is an integer which indicates how many | |
533 | leading characters agree, and which string is less. Its absolute value | |
534 | is one plus the number of characters that agree at the beginning of the | |
535 | two strings. The sign is negative if @var{string1} (or its specified | |
536 | portion) is less. | |
537 | @end defun | |
538 | ||
539 | @defun assoc-string key alist &optional case-fold | |
540 | This function works like @code{assoc}, except that @var{key} must be a | |
541 | string or symbol, and comparison is done using @code{compare-strings}. | |
542 | Symbols are converted to strings before testing. | |
543 | If @var{case-fold} is non-@code{nil}, it ignores case differences. | |
544 | Unlike @code{assoc}, this function can also match elements of the alist | |
545 | that are strings or symbols rather than conses. In particular, @var{alist} can | |
546 | be a list of strings or symbols rather than an actual alist. | |
547 | @xref{Association Lists}. | |
548 | @end defun | |
549 | ||
8f88eb24 | 550 | See also the function @code{compare-buffer-substrings} in |
b8d4c8d0 GM |
551 | @ref{Comparing Text}, for a way to compare text in buffers. The |
552 | function @code{string-match}, which matches a regular expression | |
553 | against a string, can be used for a kind of string comparison; see | |
554 | @ref{Regexp Search}. | |
555 | ||
556 | @node String Conversion | |
557 | @comment node-name, next, previous, up | |
558 | @section Conversion of Characters and Strings | |
559 | @cindex conversion of strings | |
560 | ||
8f88eb24 CY |
561 | This section describes functions for converting between characters, |
562 | strings and integers. @code{format} (@pxref{Formatting Strings}) and | |
563 | @code{prin1-to-string} (@pxref{Output Functions}) can also convert | |
564 | Lisp objects into strings. @code{read-from-string} (@pxref{Input | |
565 | Functions}) can ``convert'' a string representation of a Lisp object | |
e4021ec1 SM |
566 | into an object. The functions @code{string-to-multibyte} and |
567 | @code{string-to-unibyte} convert the text representation of a string | |
8f88eb24 | 568 | (@pxref{Converting Representations}). |
b8d4c8d0 GM |
569 | |
570 | @xref{Documentation}, for functions that produce textual descriptions | |
571 | of text characters and general input events | |
572 | (@code{single-key-description} and @code{text-char-description}). These | |
573 | are used primarily for making help messages. | |
574 | ||
b8d4c8d0 GM |
575 | @defun number-to-string number |
576 | @cindex integer to string | |
577 | @cindex integer to decimal | |
578 | This function returns a string consisting of the printed base-ten | |
579 | representation of @var{number}, which may be an integer or a floating | |
580 | point number. The returned value starts with a minus sign if the argument is | |
581 | negative. | |
582 | ||
583 | @example | |
584 | (number-to-string 256) | |
585 | @result{} "256" | |
586 | @group | |
587 | (number-to-string -23) | |
588 | @result{} "-23" | |
589 | @end group | |
590 | (number-to-string -23.5) | |
591 | @result{} "-23.5" | |
592 | @end example | |
593 | ||
594 | @cindex int-to-string | |
595 | @code{int-to-string} is a semi-obsolete alias for this function. | |
596 | ||
597 | See also the function @code{format} in @ref{Formatting Strings}. | |
598 | @end defun | |
599 | ||
600 | @defun string-to-number string &optional base | |
601 | @cindex string to number | |
602 | This function returns the numeric value of the characters in | |
603 | @var{string}. If @var{base} is non-@code{nil}, it must be an integer | |
604 | between 2 and 16 (inclusive), and integers are converted in that base. | |
605 | If @var{base} is @code{nil}, then base ten is used. Floating point | |
606 | conversion only works in base ten; we have not implemented other | |
607 | radices for floating point numbers, because that would be much more | |
608 | work and does not seem useful. If @var{string} looks like an integer | |
609 | but its value is too large to fit into a Lisp integer, | |
610 | @code{string-to-number} returns a floating point result. | |
611 | ||
612 | The parsing skips spaces and tabs at the beginning of @var{string}, | |
613 | then reads as much of @var{string} as it can interpret as a number in | |
614 | the given base. (On some systems it ignores other whitespace at the | |
615 | beginning, not just spaces and tabs.) If the first character after | |
616 | the ignored whitespace is neither a digit in the given base, nor a | |
617 | plus or minus sign, nor the leading dot of a floating point number, | |
618 | this function returns 0. | |
619 | ||
620 | @example | |
621 | (string-to-number "256") | |
622 | @result{} 256 | |
623 | (string-to-number "25 is a perfect square.") | |
624 | @result{} 25 | |
625 | (string-to-number "X256") | |
626 | @result{} 0 | |
627 | (string-to-number "-4.5") | |
628 | @result{} -4.5 | |
629 | (string-to-number "1e5") | |
630 | @result{} 100000.0 | |
631 | @end example | |
632 | ||
633 | @findex string-to-int | |
634 | @code{string-to-int} is an obsolete alias for this function. | |
3e99b825 CY |
635 | @end defun |
636 | ||
637 | @defun char-to-string character | |
638 | @cindex character to string | |
639 | This function returns a new string containing one character, | |
640 | @var{character}. This function is semi-obsolete because the function | |
641 | @code{string} is more general. @xref{Creating Strings}. | |
642 | @end defun | |
643 | ||
644 | @defun string-to-char string | |
645 | This function returns the first character in @var{string}. This | |
646 | mostly identical to @code{(aref string 0)}, except that it returns 0 | |
647 | if the string is empty. (The value is also 0 when the first character | |
648 | of @var{string} is the null character, @acronym{ASCII} code 0.) This | |
649 | function may be eliminated in the future if it does not seem useful | |
650 | enough to retain. | |
b8d4c8d0 GM |
651 | @end defun |
652 | ||
653 | Here are some other functions that can convert to or from a string: | |
654 | ||
655 | @table @code | |
656 | @item concat | |
3e99b825 | 657 | This function converts a vector or a list into a string. |
b8d4c8d0 GM |
658 | @xref{Creating Strings}. |
659 | ||
660 | @item vconcat | |
3e99b825 | 661 | This function converts a string into a vector. @xref{Vector |
b8d4c8d0 GM |
662 | Functions}. |
663 | ||
664 | @item append | |
3e99b825 CY |
665 | This function converts a string into a list. @xref{Building Lists}. |
666 | ||
667 | @item byte-to-string | |
668 | This function converts a byte of character data into a unibyte string. | |
669 | @xref{Converting Representations}. | |
b8d4c8d0 GM |
670 | @end table |
671 | ||
672 | @node Formatting Strings | |
673 | @comment node-name, next, previous, up | |
674 | @section Formatting Strings | |
675 | @cindex formatting strings | |
676 | @cindex strings, formatting them | |
677 | ||
8f88eb24 CY |
678 | @dfn{Formatting} means constructing a string by substituting |
679 | computed values at various places in a constant string. This constant | |
680 | string controls how the other values are printed, as well as where | |
681 | they appear; it is called a @dfn{format string}. | |
b8d4c8d0 GM |
682 | |
683 | Formatting is often useful for computing messages to be displayed. In | |
684 | fact, the functions @code{message} and @code{error} provide the same | |
685 | formatting feature described here; they differ from @code{format} only | |
686 | in how they use the result of formatting. | |
687 | ||
688 | @defun format string &rest objects | |
689 | This function returns a new string that is made by copying | |
690 | @var{string} and then replacing any format specification | |
691 | in the copy with encodings of the corresponding @var{objects}. The | |
692 | arguments @var{objects} are the computed values to be formatted. | |
693 | ||
694 | The characters in @var{string}, other than the format specifications, | |
695 | are copied directly into the output, including their text properties, | |
696 | if any. | |
697 | @end defun | |
698 | ||
699 | @cindex @samp{%} in format | |
700 | @cindex format specification | |
701 | A format specification is a sequence of characters beginning with a | |
702 | @samp{%}. Thus, if there is a @samp{%d} in @var{string}, the | |
703 | @code{format} function replaces it with the printed representation of | |
704 | one of the values to be formatted (one of the arguments @var{objects}). | |
705 | For example: | |
706 | ||
707 | @example | |
708 | @group | |
709 | (format "The value of fill-column is %d." fill-column) | |
710 | @result{} "The value of fill-column is 72." | |
711 | @end group | |
712 | @end example | |
713 | ||
714 | Since @code{format} interprets @samp{%} characters as format | |
715 | specifications, you should @emph{never} pass an arbitrary string as | |
716 | the first argument. This is particularly true when the string is | |
717 | generated by some Lisp code. Unless the string is @emph{known} to | |
718 | never include any @samp{%} characters, pass @code{"%s"}, described | |
719 | below, as the first argument, and the string as the second, like this: | |
720 | ||
721 | @example | |
722 | (format "%s" @var{arbitrary-string}) | |
723 | @end example | |
724 | ||
725 | If @var{string} contains more than one format specification, the | |
726 | format specifications correspond to successive values from | |
727 | @var{objects}. Thus, the first format specification in @var{string} | |
728 | uses the first such value, the second format specification uses the | |
729 | second such value, and so on. Any extra format specifications (those | |
730 | for which there are no corresponding values) cause an error. Any | |
731 | extra values to be formatted are ignored. | |
732 | ||
733 | Certain format specifications require values of particular types. If | |
734 | you supply a value that doesn't fit the requirements, an error is | |
735 | signaled. | |
736 | ||
737 | Here is a table of valid format specifications: | |
738 | ||
739 | @table @samp | |
740 | @item %s | |
741 | Replace the specification with the printed representation of the object, | |
742 | made without quoting (that is, using @code{princ}, not | |
743 | @code{prin1}---@pxref{Output Functions}). Thus, strings are represented | |
744 | by their contents alone, with no @samp{"} characters, and symbols appear | |
745 | without @samp{\} characters. | |
746 | ||
747 | If the object is a string, its text properties are | |
748 | copied into the output. The text properties of the @samp{%s} itself | |
749 | are also copied, but those of the object take priority. | |
750 | ||
751 | @item %S | |
752 | Replace the specification with the printed representation of the object, | |
753 | made with quoting (that is, using @code{prin1}---@pxref{Output | |
754 | Functions}). Thus, strings are enclosed in @samp{"} characters, and | |
755 | @samp{\} characters appear where necessary before special characters. | |
756 | ||
757 | @item %o | |
758 | @cindex integer to octal | |
759 | Replace the specification with the base-eight representation of an | |
760 | integer. | |
761 | ||
762 | @item %d | |
763 | Replace the specification with the base-ten representation of an | |
764 | integer. | |
765 | ||
766 | @item %x | |
767 | @itemx %X | |
768 | @cindex integer to hexadecimal | |
769 | Replace the specification with the base-sixteen representation of an | |
770 | integer. @samp{%x} uses lower case and @samp{%X} uses upper case. | |
771 | ||
772 | @item %c | |
773 | Replace the specification with the character which is the value given. | |
774 | ||
775 | @item %e | |
776 | Replace the specification with the exponential notation for a floating | |
777 | point number. | |
778 | ||
779 | @item %f | |
780 | Replace the specification with the decimal-point notation for a floating | |
781 | point number. | |
782 | ||
783 | @item %g | |
784 | Replace the specification with notation for a floating point number, | |
785 | using either exponential notation or decimal-point notation, whichever | |
786 | is shorter. | |
787 | ||
788 | @item %% | |
789 | Replace the specification with a single @samp{%}. This format | |
790 | specification is unusual in that it does not use a value. For example, | |
791 | @code{(format "%% %d" 30)} returns @code{"% 30"}. | |
792 | @end table | |
793 | ||
794 | Any other format character results in an @samp{Invalid format | |
795 | operation} error. | |
796 | ||
797 | Here are several examples: | |
798 | ||
799 | @example | |
800 | @group | |
801 | (format "The name of this buffer is %s." (buffer-name)) | |
802 | @result{} "The name of this buffer is strings.texi." | |
803 | ||
804 | (format "The buffer object prints as %s." (current-buffer)) | |
805 | @result{} "The buffer object prints as strings.texi." | |
806 | ||
807 | (format "The octal value of %d is %o, | |
808 | and the hex value is %x." 18 18 18) | |
809 | @result{} "The octal value of 18 is 22, | |
810 | and the hex value is 12." | |
811 | @end group | |
812 | @end example | |
813 | ||
814 | @cindex field width | |
815 | @cindex padding | |
b20e7c7d CY |
816 | A specification can have a @dfn{width}, which is a decimal number |
817 | between the @samp{%} and the specification character. If the printed | |
818 | representation of the object contains fewer characters than this | |
819 | width, @code{format} extends it with padding. The width specifier is | |
820 | ignored for the @samp{%%} specification. Any padding introduced by | |
821 | the width specifier normally consists of spaces inserted on the left: | |
b8d4c8d0 GM |
822 | |
823 | @example | |
b20e7c7d CY |
824 | (format "%5d is padded on the left with spaces" 123) |
825 | @result{} " 123 is padded on the left with spaces" | |
b8d4c8d0 GM |
826 | @end example |
827 | ||
828 | @noindent | |
829 | If the width is too small, @code{format} does not truncate the | |
830 | object's printed representation. Thus, you can use a width to specify | |
831 | a minimum spacing between columns with no risk of losing information. | |
b20e7c7d CY |
832 | In the following three examples, @samp{%7s} specifies a minimum width |
833 | of 7. In the first case, the string inserted in place of @samp{%7s} | |
834 | has only 3 letters, and needs 4 blank spaces as padding. In the | |
835 | second case, the string @code{"specification"} is 13 letters wide but | |
836 | is not truncated. | |
b8d4c8d0 | 837 | |
b20e7c7d | 838 | @example |
b8d4c8d0 | 839 | @group |
049bcbcb | 840 | (format "The word `%7s' has %d letters in it." |
b8d4c8d0 | 841 | "foo" (length "foo")) |
049bcbcb CY |
842 | @result{} "The word ` foo' has 3 letters in it." |
843 | (format "The word `%7s' has %d letters in it." | |
b8d4c8d0 | 844 | "specification" (length "specification")) |
049bcbcb | 845 | @result{} "The word `specification' has 13 letters in it." |
b8d4c8d0 | 846 | @end group |
b20e7c7d CY |
847 | @end example |
848 | ||
849 | @cindex flags in format specifications | |
850 | Immediately after the @samp{%} and before the optional width | |
851 | specifier, you can also put certain @dfn{flag characters}. | |
852 | ||
853 | The flag @samp{+} inserts a plus sign before a positive number, so | |
854 | that it always has a sign. A space character as flag inserts a space | |
855 | before a positive number. (Otherwise, positive numbers start with the | |
856 | first digit.) These flags are useful for ensuring that positive | |
857 | numbers and negative numbers use the same number of columns. They are | |
858 | ignored except for @samp{%d}, @samp{%e}, @samp{%f}, @samp{%g}, and if | |
859 | both flags are used, @samp{+} takes precedence. | |
860 | ||
861 | The flag @samp{#} specifies an ``alternate form'' which depends on | |
862 | the format in use. For @samp{%o}, it ensures that the result begins | |
863 | with a @samp{0}. For @samp{%x} and @samp{%X}, it prefixes the result | |
864 | with @samp{0x} or @samp{0X}. For @samp{%e}, @samp{%f}, and @samp{%g}, | |
865 | the @samp{#} flag means include a decimal point even if the precision | |
866 | is zero. | |
867 | ||
a9ab721e LMI |
868 | The flag @samp{0} ensures that the padding consists of @samp{0} |
869 | characters instead of spaces. This flag is ignored for non-numerical | |
870 | specification characters like @samp{%s}, @samp{%S} and @samp{%c}. | |
871 | These specification characters accept the @samp{0} flag, but still pad | |
872 | with @emph{spaces}. | |
873 | ||
b20e7c7d CY |
874 | The flag @samp{-} causes the padding inserted by the width |
875 | specifier, if any, to be inserted on the right rather than the left. | |
a9ab721e LMI |
876 | If both @samp{-} and @samp{0} are present, the @samp{0} flag is |
877 | ignored. | |
b8d4c8d0 | 878 | |
b20e7c7d | 879 | @example |
b8d4c8d0 | 880 | @group |
b20e7c7d CY |
881 | (format "%06d is padded on the left with zeros" 123) |
882 | @result{} "000123 is padded on the left with zeros" | |
883 | ||
884 | (format "%-6d is padded on the right" 123) | |
885 | @result{} "123 is padded on the right" | |
886 | ||
b8d4c8d0 GM |
887 | (format "The word `%-7s' actually has %d letters in it." |
888 | "foo" (length "foo")) | |
889 | @result{} "The word `foo ' actually has 3 letters in it." | |
890 | @end group | |
b20e7c7d | 891 | @end example |
b8d4c8d0 GM |
892 | |
893 | @cindex precision in format specifications | |
894 | All the specification characters allow an optional @dfn{precision} | |
895 | before the character (after the width, if present). The precision is | |
896 | a decimal-point @samp{.} followed by a digit-string. For the | |
897 | floating-point specifications (@samp{%e}, @samp{%f}, @samp{%g}), the | |
898 | precision specifies how many decimal places to show; if zero, the | |
899 | decimal-point itself is also omitted. For @samp{%s} and @samp{%S}, | |
900 | the precision truncates the string to the given width, so @samp{%.3s} | |
901 | shows only the first three characters of the representation for | |
902 | @var{object}. Precision has no effect for other specification | |
903 | characters. | |
904 | ||
b8d4c8d0 GM |
905 | @node Case Conversion |
906 | @comment node-name, next, previous, up | |
907 | @section Case Conversion in Lisp | |
908 | @cindex upper case | |
909 | @cindex lower case | |
910 | @cindex character case | |
911 | @cindex case conversion in Lisp | |
912 | ||
913 | The character case functions change the case of single characters or | |
914 | of the contents of strings. The functions normally convert only | |
915 | alphabetic characters (the letters @samp{A} through @samp{Z} and | |
916 | @samp{a} through @samp{z}, as well as non-@acronym{ASCII} letters); other | |
917 | characters are not altered. You can specify a different case | |
918 | conversion mapping by specifying a case table (@pxref{Case Tables}). | |
919 | ||
920 | These functions do not modify the strings that are passed to them as | |
921 | arguments. | |
922 | ||
923 | The examples below use the characters @samp{X} and @samp{x} which have | |
924 | @acronym{ASCII} codes 88 and 120 respectively. | |
925 | ||
926 | @defun downcase string-or-char | |
8f88eb24 CY |
927 | This function converts @var{string-or-char}, which should be either a |
928 | character or a string, to lower case. | |
b8d4c8d0 | 929 | |
8f88eb24 CY |
930 | When @var{string-or-char} is a string, this function returns a new |
931 | string in which each letter in the argument that is upper case is | |
932 | converted to lower case. When @var{string-or-char} is a character, | |
933 | this function returns the corresponding lower case character (an | |
934 | integer); if the original character is lower case, or is not a letter, | |
935 | the return value is equal to the original character. | |
b8d4c8d0 GM |
936 | |
937 | @example | |
938 | (downcase "The cat in the hat") | |
939 | @result{} "the cat in the hat" | |
940 | ||
941 | (downcase ?X) | |
942 | @result{} 120 | |
943 | @end example | |
944 | @end defun | |
945 | ||
946 | @defun upcase string-or-char | |
8f88eb24 CY |
947 | This function converts @var{string-or-char}, which should be either a |
948 | character or a string, to upper case. | |
b8d4c8d0 | 949 | |
8f88eb24 CY |
950 | When @var{string-or-char} is a string, this function returns a new |
951 | string in which each letter in the argument that is lower case is | |
952 | converted to upper case. When @var{string-or-char} is a character, | |
a86cd395 | 953 | this function returns the corresponding upper case character (an |
8f88eb24 CY |
954 | integer); if the original character is upper case, or is not a letter, |
955 | the return value is equal to the original character. | |
b8d4c8d0 GM |
956 | |
957 | @example | |
958 | (upcase "The cat in the hat") | |
959 | @result{} "THE CAT IN THE HAT" | |
960 | ||
961 | (upcase ?x) | |
962 | @result{} 88 | |
963 | @end example | |
964 | @end defun | |
965 | ||
966 | @defun capitalize string-or-char | |
967 | @cindex capitalization | |
968 | This function capitalizes strings or characters. If | |
8f88eb24 CY |
969 | @var{string-or-char} is a string, the function returns a new string |
970 | whose contents are a copy of @var{string-or-char} in which each word | |
971 | has been capitalized. This means that the first character of each | |
b8d4c8d0 GM |
972 | word is converted to upper case, and the rest are converted to lower |
973 | case. | |
974 | ||
975 | The definition of a word is any sequence of consecutive characters that | |
976 | are assigned to the word constituent syntax class in the current syntax | |
977 | table (@pxref{Syntax Class Table}). | |
978 | ||
8f88eb24 CY |
979 | When @var{string-or-char} is a character, this function does the same |
980 | thing as @code{upcase}. | |
b8d4c8d0 GM |
981 | |
982 | @example | |
983 | @group | |
984 | (capitalize "The cat in the hat") | |
985 | @result{} "The Cat In The Hat" | |
986 | @end group | |
987 | ||
988 | @group | |
989 | (capitalize "THE 77TH-HATTED CAT") | |
990 | @result{} "The 77th-Hatted Cat" | |
991 | @end group | |
992 | ||
993 | @group | |
994 | (capitalize ?x) | |
995 | @result{} 88 | |
996 | @end group | |
997 | @end example | |
998 | @end defun | |
999 | ||
1000 | @defun upcase-initials string-or-char | |
1001 | If @var{string-or-char} is a string, this function capitalizes the | |
1002 | initials of the words in @var{string-or-char}, without altering any | |
1003 | letters other than the initials. It returns a new string whose | |
1004 | contents are a copy of @var{string-or-char}, in which each word has | |
1005 | had its initial letter converted to upper case. | |
1006 | ||
1007 | The definition of a word is any sequence of consecutive characters that | |
1008 | are assigned to the word constituent syntax class in the current syntax | |
1009 | table (@pxref{Syntax Class Table}). | |
1010 | ||
1011 | When the argument to @code{upcase-initials} is a character, | |
1012 | @code{upcase-initials} has the same result as @code{upcase}. | |
1013 | ||
1014 | @example | |
1015 | @group | |
1016 | (upcase-initials "The CAT in the hAt") | |
1017 | @result{} "The CAT In The HAt" | |
1018 | @end group | |
1019 | @end example | |
1020 | @end defun | |
1021 | ||
1022 | @xref{Text Comparison}, for functions that compare strings; some of | |
1023 | them ignore case differences, or can optionally ignore case differences. | |
1024 | ||
1025 | @node Case Tables | |
1026 | @section The Case Table | |
1027 | ||
1028 | You can customize case conversion by installing a special @dfn{case | |
1029 | table}. A case table specifies the mapping between upper case and lower | |
1030 | case letters. It affects both the case conversion functions for Lisp | |
1031 | objects (see the previous section) and those that apply to text in the | |
1032 | buffer (@pxref{Case Changes}). Each buffer has a case table; there is | |
1033 | also a standard case table which is used to initialize the case table | |
1034 | of new buffers. | |
1035 | ||
1036 | A case table is a char-table (@pxref{Char-Tables}) whose subtype is | |
1037 | @code{case-table}. This char-table maps each character into the | |
1038 | corresponding lower case character. It has three extra slots, which | |
1039 | hold related tables: | |
1040 | ||
1041 | @table @var | |
1042 | @item upcase | |
1043 | The upcase table maps each character into the corresponding upper | |
1044 | case character. | |
1045 | @item canonicalize | |
1046 | The canonicalize table maps all of a set of case-related characters | |
1047 | into a particular member of that set. | |
1048 | @item equivalences | |
1049 | The equivalences table maps each one of a set of case-related characters | |
1050 | into the next character in that set. | |
1051 | @end table | |
1052 | ||
1053 | In simple cases, all you need to specify is the mapping to lower-case; | |
1054 | the three related tables will be calculated automatically from that one. | |
1055 | ||
1056 | For some languages, upper and lower case letters are not in one-to-one | |
1057 | correspondence. There may be two different lower case letters with the | |
1058 | same upper case equivalent. In these cases, you need to specify the | |
1059 | maps for both lower case and upper case. | |
1060 | ||
1061 | The extra table @var{canonicalize} maps each character to a canonical | |
1062 | equivalent; any two characters that are related by case-conversion have | |
1063 | the same canonical equivalent character. For example, since @samp{a} | |
1064 | and @samp{A} are related by case-conversion, they should have the same | |
1065 | canonical equivalent character (which should be either @samp{a} for both | |
1066 | of them, or @samp{A} for both of them). | |
1067 | ||
1068 | The extra table @var{equivalences} is a map that cyclically permutes | |
1069 | each equivalence class (of characters with the same canonical | |
1070 | equivalent). (For ordinary @acronym{ASCII}, this would map @samp{a} into | |
1071 | @samp{A} and @samp{A} into @samp{a}, and likewise for each set of | |
1072 | equivalent characters.) | |
1073 | ||
8f88eb24 | 1074 | When constructing a case table, you can provide @code{nil} for |
b8d4c8d0 GM |
1075 | @var{canonicalize}; then Emacs fills in this slot from the lower case |
1076 | and upper case mappings. You can also provide @code{nil} for | |
1077 | @var{equivalences}; then Emacs fills in this slot from | |
1078 | @var{canonicalize}. In a case table that is actually in use, those | |
8f88eb24 CY |
1079 | components are non-@code{nil}. Do not try to specify |
1080 | @var{equivalences} without also specifying @var{canonicalize}. | |
b8d4c8d0 GM |
1081 | |
1082 | Here are the functions for working with case tables: | |
1083 | ||
1084 | @defun case-table-p object | |
1085 | This predicate returns non-@code{nil} if @var{object} is a valid case | |
1086 | table. | |
1087 | @end defun | |
1088 | ||
1089 | @defun set-standard-case-table table | |
1090 | This function makes @var{table} the standard case table, so that it will | |
1091 | be used in any buffers created subsequently. | |
1092 | @end defun | |
1093 | ||
1094 | @defun standard-case-table | |
1095 | This returns the standard case table. | |
1096 | @end defun | |
1097 | ||
1098 | @defun current-case-table | |
1099 | This function returns the current buffer's case table. | |
1100 | @end defun | |
1101 | ||
1102 | @defun set-case-table table | |
1103 | This sets the current buffer's case table to @var{table}. | |
1104 | @end defun | |
1105 | ||
1106 | @defmac with-case-table table body@dots{} | |
1107 | The @code{with-case-table} macro saves the current case table, makes | |
1108 | @var{table} the current case table, evaluates the @var{body} forms, | |
1109 | and finally restores the case table. The return value is the value of | |
1110 | the last form in @var{body}. The case table is restored even in case | |
1111 | of an abnormal exit via @code{throw} or error (@pxref{Nonlocal | |
1112 | Exits}). | |
1113 | @end defmac | |
1114 | ||
8f88eb24 | 1115 | Some language environments modify the case conversions of |
b8d4c8d0 GM |
1116 | @acronym{ASCII} characters; for example, in the Turkish language |
1117 | environment, the @acronym{ASCII} character @samp{I} is downcased into | |
1118 | a Turkish ``dotless i''. This can interfere with code that requires | |
9fce7eda | 1119 | ordinary @acronym{ASCII} case conversion, such as implementations of |
b8d4c8d0 GM |
1120 | @acronym{ASCII}-based network protocols. In that case, use the |
1121 | @code{with-case-table} macro with the variable @var{ascii-case-table}, | |
1122 | which stores the unmodified case table for the @acronym{ASCII} | |
1123 | character set. | |
1124 | ||
1125 | @defvar ascii-case-table | |
1126 | The case table for the @acronym{ASCII} character set. This should not be | |
1127 | modified by any language environment settings. | |
1128 | @end defvar | |
1129 | ||
1130 | The following three functions are convenient subroutines for packages | |
1131 | that define non-@acronym{ASCII} character sets. They modify the specified | |
1132 | case table @var{case-table}; they also modify the standard syntax table. | |
1133 | @xref{Syntax Tables}. Normally you would use these functions to change | |
1134 | the standard case table. | |
1135 | ||
1136 | @defun set-case-syntax-pair uc lc case-table | |
1137 | This function specifies a pair of corresponding letters, one upper case | |
1138 | and one lower case. | |
1139 | @end defun | |
1140 | ||
1141 | @defun set-case-syntax-delims l r case-table | |
1142 | This function makes characters @var{l} and @var{r} a matching pair of | |
1143 | case-invariant delimiters. | |
1144 | @end defun | |
1145 | ||
1146 | @defun set-case-syntax char syntax case-table | |
1147 | This function makes @var{char} case-invariant, with syntax | |
1148 | @var{syntax}. | |
1149 | @end defun | |
1150 | ||
1151 | @deffn Command describe-buffer-case-table | |
1152 | This command displays a description of the contents of the current | |
1153 | buffer's case table. | |
1154 | @end deffn |