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