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