*** empty log message ***
[emacs.git] / lispref / strings.texi
blobf35f94b2bc4ae74a4e09e90938b79dd0ec923b2f
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
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
263 This function splits @var{string} into substrings at matches for the regular
264 expression @var{separators}.  Each match for @var{separators} defines a
265 splitting point; the substrings between the splitting points are made
266 into a list, which is the value returned by @code{split-string}.
267 If @var{separators} is @code{nil} (or omitted),
268 the default is @code{"[ \f\t\n\r\v]+"}.
270 For example,
272 @example
273 (split-string "Soup is good food" "o")
274 @result{} ("S" "up is g" "" "d f" "" "d")
275 (split-string "Soup is good food" "o+")
276 @result{} ("S" "up is g" "d f" "d")
277 @end example
279 When there is a match adjacent to the beginning or end of the string,
280 this does not cause a null string to appear at the beginning or end
281 of the list:
283 @example
284 (split-string "out to moo" "o+")
285 @result{} ("ut t" " m")
286 @end example
288 Empty matches do count, when not adjacent to another match:
290 @example
291 (split-string "Soup is good food" "o*")
292 @result{}("S" "u" "p" " " "i" "s" " " "g" "d" " " "f" "d")
293 (split-string "Nice doggy!" "")
294 @result{}("N" "i" "c" "e" " " "d" "o" "g" "g" "y" "!")
295 @end example
296 @end defun
298 @node Modifying Strings
299 @section Modifying Strings
301   The most basic way to alter the contents of an existing string is with
302 @code{aset} (@pxref{Array Functions}).  @code{(aset @var{string}
303 @var{idx} @var{char})} stores @var{char} into @var{string} at index
304 @var{idx}.  Each character occupies one or more bytes, and if @var{char}
305 needs a different number of bytes from the character already present at
306 that index, @code{aset} signals an error.
308   A more powerful function is @code{store-substring}:
310 @defun store-substring string idx obj
311 This function alters part of the contents of the string @var{string}, by
312 storing @var{obj} starting at index @var{idx}.  The argument @var{obj}
313 may be either a character or a (smaller) string.
315 Since it is impossible to change the length of an existing string, it is
316 an error if @var{obj} doesn't fit within @var{string}'s actual length,
317 or if any new character requires a different number of bytes from the
318 character currently present at that point in @var{string}.
319 @end defun
321 @need 2000
322 @node Text Comparison
323 @section Comparison of Characters and Strings
324 @cindex string equality
326 @defun char-equal character1 character2
327 This function returns @code{t} if the arguments represent the same
328 character, @code{nil} otherwise.  This function ignores differences
329 in case if @code{case-fold-search} is non-@code{nil}.
331 @example
332 (char-equal ?x ?x)
333      @result{} t
334 (let ((case-fold-search nil))
335   (char-equal ?x ?X))
336      @result{} nil
337 @end example
338 @end defun
340 @defun string= string1 string2
341 This function returns @code{t} if the characters of the two strings
342 match exactly.
343 Case is always significant, regardless of @code{case-fold-search}.
345 @example
346 (string= "abc" "abc")
347      @result{} t
348 (string= "abc" "ABC")
349      @result{} nil
350 (string= "ab" "ABC")
351      @result{} nil
352 @end example
354 The function @code{string=} ignores the text properties of the two
355 strings.  When @code{equal} (@pxref{Equality Predicates}) compares two
356 strings, it uses @code{string=}.
358 If the strings contain non-@sc{ascii} characters, and one is unibyte
359 while the other is multibyte, then they cannot be equal.  @xref{Text
360 Representations}.
361 @end defun
363 @defun string-equal string1 string2
364 @code{string-equal} is another name for @code{string=}.
365 @end defun
367 @cindex lexical comparison
368 @defun string< string1 string2
369 @c (findex string< causes problems for permuted index!!)
370 This function compares two strings a character at a time.  It
371 scans both the strings at the same time to find the first pair of corresponding
372 characters that do not match.  If the lesser character of these two is
373 the character from @var{string1}, then @var{string1} is less, and this
374 function returns @code{t}.  If the lesser character is the one from
375 @var{string2}, then @var{string1} is greater, and this function returns
376 @code{nil}.  If the two strings match entirely, the value is @code{nil}.
378 Pairs of characters are compared according to their character codes.
379 Keep in mind that lower case letters have higher numeric values in the
380 @sc{ascii} character set than their upper case counterparts; digits and
381 many punctuation characters have a lower numeric value than upper case
382 letters.  An @sc{ascii} character is less than any non-@sc{ascii}
383 character; a unibyte non-@sc{ascii} character is always less than any
384 multibyte non-@sc{ascii} character (@pxref{Text Representations}).
386 @example
387 @group
388 (string< "abc" "abd")
389      @result{} t
390 (string< "abd" "abc")
391      @result{} nil
392 (string< "123" "abc")
393      @result{} t
394 @end group
395 @end example
397 When the strings have different lengths, and they match up to the
398 length of @var{string1}, then the result is @code{t}.  If they match up
399 to the length of @var{string2}, the result is @code{nil}.  A string of
400 no characters is less than any other string.
402 @example
403 @group
404 (string< "" "abc")
405      @result{} t
406 (string< "ab" "abc")
407      @result{} t
408 (string< "abc" "")
409      @result{} nil
410 (string< "abc" "ab")
411      @result{} nil
412 (string< "" "")
413      @result{} nil                   
414 @end group
415 @end example
416 @end defun
418 @defun string-lessp string1 string2
419 @code{string-lessp} is another name for @code{string<}.
420 @end defun
422 @defun compare-strings string1 start1 end1 string2 start2 end2 &optional ignore-case
423 This function compares the specified part of @var{string1} with the
424 specified part of @var{string2}.  The specified part of @var{string1}
425 runs from index @var{start1} up to index @var{end1} (@code{nil} means
426 the end of the string).  The specified part of @var{string2} runs from
427 index @var{start2} up to index @var{end2} (@code{nil} means the end of
428 the string).
430 The strings are both converted to multibyte for the comparison
431 (@pxref{Text Representations}) so that a unibyte string can be equal to
432 a multibyte string.  If @var{ignore-case} is non-@code{nil}, then case
433 is ignored, so that upper case letters can be equal to lower case letters.
435 If the specified portions of the two strings match, the value is
436 @code{t}.  Otherwise, the value is an integer which indicates how many
437 leading characters agree, and which string is less.  Its absolute value
438 is one plus the number of characters that agree at the beginning of the
439 two strings.  The sign is negative if @var{string1} (or its specified
440 portion) is less.
441 @end defun
443 @defun assoc-ignore-case key alist
444 This function works like @code{assoc}, except that @var{key} must be a
445 string, and comparison is done using @code{compare-strings}, ignoring
446 case differences.  @xref{Association Lists}.
447 @end defun
449 @defun assoc-ignore-representation key alist
450 This function works like @code{assoc}, except that @var{key} must be a
451 string, and comparison is done using @code{compare-strings}.
452 Case differences are significant.
453 @end defun
455   See also @code{compare-buffer-substrings} in @ref{Comparing Text}, for
456 a way to compare text in buffers.  The function @code{string-match},
457 which matches a regular expression against a string, can be used
458 for a kind of string comparison; see @ref{Regexp Search}.
460 @node String Conversion
461 @comment  node-name,  next,  previous,  up
462 @section Conversion of Characters and Strings
463 @cindex conversion of strings
465   This section describes functions for conversions between characters,
466 strings and integers.  @code{format} and @code{prin1-to-string}
467 (@pxref{Output Functions}) can also convert Lisp objects into strings.
468 @code{read-from-string} (@pxref{Input Functions}) can ``convert'' a
469 string representation of a Lisp object into an object.  The functions
470 @code{string-make-multibyte} and @code{string-make-unibyte} convert the
471 text representation of a string (@pxref{Converting Representations}).
473   @xref{Documentation}, for functions that produce textual descriptions
474 of text characters and general input events
475 (@code{single-key-description} and @code{text-char-description}).  These
476 functions are used primarily for making help messages.
478 @defun char-to-string character
479 @cindex character to string
480 This function returns a new string containing one character,
481 @var{character}.  This function is semi-obsolete because the function
482 @code{string} is more general.  @xref{Creating Strings}.
483 @end defun
485 @defun string-to-char string
486 @cindex string to character
487   This function returns the first character in @var{string}.  If the
488 string is empty, the function returns 0.  The value is also 0 when the
489 first character of @var{string} is the null character, @sc{ascii} code
492 @example
493 (string-to-char "ABC")
494      @result{} 65
495 (string-to-char "xyz")
496      @result{} 120
497 (string-to-char "")
498      @result{} 0
499 @group
500 (string-to-char "\000")
501      @result{} 0
502 @end group
503 @end example
505 This function may be eliminated in the future if it does not seem useful
506 enough to retain.
507 @end defun
509 @defun number-to-string number
510 @cindex integer to string
511 @cindex integer to decimal
512 This function returns a string consisting of the printed base-ten
513 representation of @var{number}, which may be an integer or a floating
514 point number.  The returned value starts with a minus sign if the argument is
515 negative.
517 @example
518 (number-to-string 256)
519      @result{} "256"
520 (number-to-string -23)
521      @result{} "-23"
522 (number-to-string -23.5)
523      @result{} "-23.5"
524 @end example
526 @cindex int-to-string
527 @code{int-to-string} is a semi-obsolete alias for this function.
529 See also the function @code{format} in @ref{Formatting Strings}.
530 @end defun
532 @defun string-to-number string &optional base
533 @cindex string to number
534 This function returns the numeric value of the characters in
535 @var{string}.  If @var{base} is non-@code{nil}, integers are converted
536 in that base.  If @var{base} is @code{nil}, then base ten is used.
537 Floating point conversion always uses base ten; we have not implemented
538 other radices for floating point numbers, because that would be much
539 more work and does not seem useful.  If @var{string} looks like an
540 integer but its value is too large to fit into a Lisp integer,
541 @code{string-to-number} returns a floating point result.
543 The parsing skips spaces and tabs at the beginning of @var{string}, then
544 reads as much of @var{string} as it can interpret as a number.  (On some
545 systems it ignores other whitespace at the beginning, not just spaces
546 and tabs.)  If the first character after the ignored whitespace is
547 neither a digit, nor a plus or minus sign, nor the leading dot of a
548 floating point number, this function returns 0.
550 @example
551 (string-to-number "256")
552      @result{} 256
553 (string-to-number "25 is a perfect square.")
554      @result{} 25
555 (string-to-number "X256")
556      @result{} 0
557 (string-to-number "-4.5")
558      @result{} -4.5
559 (string-to-number "1e5")
560      @result{} 100000.0
561 @end example
563 @findex string-to-int
564 @code{string-to-int} is an obsolete alias for this function.
565 @end defun
567   Here are some other functions that can convert to or from a string:
569 @table @code
570 @item concat
571 @code{concat} can convert a vector or a list into a string.
572 @xref{Creating Strings}.
574 @item vconcat
575 @code{vconcat} can convert a string into a vector.  @xref{Vector
576 Functions}.
578 @item append
579 @code{append} can convert a string into a list.  @xref{Building Lists}.
580 @end table
582 @node Formatting Strings
583 @comment  node-name,  next,  previous,  up
584 @section Formatting Strings
585 @cindex formatting strings
586 @cindex strings, formatting them
588   @dfn{Formatting} means constructing a string by substitution of
589 computed values at various places in a constant string.  This constant string
590 controls how the other values are printed, as well as where they appear;
591 it is called a @dfn{format string}.
593   Formatting is often useful for computing messages to be displayed.  In
594 fact, the functions @code{message} and @code{error} provide the same
595 formatting feature described here; they differ from @code{format} only
596 in how they use the result of formatting.
598 @defun format string &rest objects
599 This function returns a new string that is made by copying
600 @var{string} and then replacing any format specification 
601 in the copy with encodings of the corresponding @var{objects}.  The
602 arguments @var{objects} are the computed values to be formatted.
604 The characters in @var{string}, other than the format specifications,
605 are copied directly into the output; starting in Emacs 21, if they have
606 text properties, these are copied into the output also.
607 @end defun
609 @cindex @samp{%} in format
610 @cindex format specification
611   A format specification is a sequence of characters beginning with a
612 @samp{%}.  Thus, if there is a @samp{%d} in @var{string}, the
613 @code{format} function replaces it with the printed representation of
614 one of the values to be formatted (one of the arguments @var{objects}).
615 For example:
617 @example
618 @group
619 (format "The value of fill-column is %d." fill-column)
620      @result{} "The value of fill-column is 72."
621 @end group
622 @end example
624   If @var{string} contains more than one format specification, the
625 format specifications correspond to successive values from
626 @var{objects}.  Thus, the first format specification in @var{string}
627 uses the first such value, the second format specification uses the
628 second such value, and so on.  Any extra format specifications (those
629 for which there are no corresponding values) cause unpredictable
630 behavior.  Any extra values to be formatted are ignored.
632   Certain format specifications require values of particular types.  If
633 you supply a value that doesn't fit the requirements, an error is
634 signaled.
636   Here is a table of valid format specifications:
638 @table @samp
639 @item %s
640 Replace the specification with the printed representation of the object,
641 made without quoting (that is, using @code{princ}, not
642 @code{prin1}---@pxref{Output Functions}).  Thus, strings are represented
643 by their contents alone, with no @samp{"} characters, and symbols appear
644 without @samp{\} characters.
646 Starting in Emacs 21, if the object is a string, its text properties are
647 copied into the output.  The text properties of the @samp{%s} itself
648 are also copied, but those of the object take priority.
650 If there is no corresponding object, the empty string is used.
652 @item %S
653 Replace the specification with the printed representation of the object,
654 made with quoting (that is, using @code{prin1}---@pxref{Output
655 Functions}).  Thus, strings are enclosed in @samp{"} characters, and
656 @samp{\} characters appear where necessary before special characters.
658 If there is no corresponding object, the empty string is used.
660 @item %o
661 @cindex integer to octal
662 Replace the specification with the base-eight representation of an
663 integer.
665 @item %d
666 Replace the specification with the base-ten representation of an
667 integer.
669 @item %x
670 @itemx %X
671 @cindex integer to hexadecimal
672 Replace the specification with the base-sixteen representation of an
673 integer.  @samp{%x} uses lower case and @samp{%X} uses upper case.
675 @item %c
676 Replace the specification with the character which is the value given.
678 @item %e
679 Replace the specification with the exponential notation for a floating
680 point number.
682 @item %f
683 Replace the specification with the decimal-point notation for a floating
684 point number.
686 @item %g
687 Replace the specification with notation for a floating point number,
688 using either exponential notation or decimal-point notation, whichever
689 is shorter.
691 @item %%
692 Replace the specification with a single @samp{%}.  This format
693 specification is unusual in that it does not use a value.  For example,
694 @code{(format "%% %d" 30)} returns @code{"% 30"}.
695 @end table
697   Any other format character results in an @samp{Invalid format
698 operation} error.
700   Here are several examples:
702 @example
703 @group
704 (format "The name of this buffer is %s." (buffer-name))
705      @result{} "The name of this buffer is strings.texi."
707 (format "The buffer object prints as %s." (current-buffer))
708      @result{} "The buffer object prints as strings.texi."
710 (format "The octal value of %d is %o, 
711          and the hex value is %x." 18 18 18)
712      @result{} "The octal value of 18 is 22, 
713          and the hex value is 12."
714 @end group
715 @end example
717 @cindex numeric prefix
718 @cindex field width
719 @cindex padding
720   All the specification characters allow an optional numeric prefix
721 between the @samp{%} and the character.  The optional numeric prefix
722 defines the minimum width for the object.  If the printed representation
723 of the object contains fewer characters than this, then it is padded.
724 The padding is on the left if the prefix is positive (or starts with
725 zero) and on the right if the prefix is negative.  The padding character
726 is normally a space, but if the numeric prefix starts with a zero, zeros
727 are used for padding.  Here are some examples of padding:
729 @example
730 (format "%06d is padded on the left with zeros" 123)
731      @result{} "000123 is padded on the left with zeros"
733 (format "%-6d is padded on the right" 123)
734      @result{} "123    is padded on the right"
735 @end example
737   @code{format} never truncates an object's printed representation, no
738 matter what width you specify.  Thus, you can use a numeric prefix to
739 specify a minimum spacing between columns with no risk of losing
740 information.
742   In the following three examples, @samp{%7s} specifies a minimum width
743 of 7.  In the first case, the string inserted in place of @samp{%7s} has
744 only 3 letters, so 4 blank spaces are inserted for padding.  In the
745 second case, the string @code{"specification"} is 13 letters wide but is
746 not truncated.  In the third case, the padding is on the right.
748 @smallexample 
749 @group
750 (format "The word `%7s' actually has %d letters in it."
751         "foo" (length "foo"))
752      @result{} "The word `    foo' actually has 3 letters in it."  
753 @end group
755 @group
756 (format "The word `%7s' actually has %d letters in it."
757         "specification" (length "specification")) 
758      @result{} "The word `specification' actually has 13 letters in it."  
759 @end group
761 @group
762 (format "The word `%-7s' actually has %d letters in it."
763         "foo" (length "foo"))
764      @result{} "The word `foo    ' actually has 3 letters in it."  
765 @end group
766 @end smallexample
768 @node Case Conversion
769 @comment node-name, next, previous, up 
770 @section Case Conversion in Lisp
771 @cindex upper case 
772 @cindex lower case 
773 @cindex character case 
774 @cindex case conversion in Lisp
776   The character case functions change the case of single characters or
777 of the contents of strings.  The functions normally convert only
778 alphabetic characters (the letters @samp{A} through @samp{Z} and
779 @samp{a} through @samp{z}, as well as non-@sc{ascii} letters); other
780 characters are not altered.  You can specify a different case
781 conversion mapping by specifying a case table (@pxref{Case Tables}).
783   These functions do not modify the strings that are passed to them as
784 arguments.
786   The examples below use the characters @samp{X} and @samp{x} which have
787 @sc{ascii} codes 88 and 120 respectively.
789 @defun downcase string-or-char
790 This function converts a character or a string to lower case.
792 When the argument to @code{downcase} is a string, the function creates
793 and returns a new string in which each letter in the argument that is
794 upper case is converted to lower case.  When the argument to
795 @code{downcase} is a character, @code{downcase} returns the
796 corresponding lower case character.  This value is an integer.  If the
797 original character is lower case, or is not a letter, then the value
798 equals the original character.
800 @example
801 (downcase "The cat in the hat")
802      @result{} "the cat in the hat"
804 (downcase ?X)
805      @result{} 120
806 @end example
807 @end defun
809 @defun upcase string-or-char
810 This function converts a character or a string to upper case.
812 When the argument to @code{upcase} is a string, the function creates
813 and returns a new string in which each letter in the argument that is
814 lower case is converted to upper case.
816 When the argument to @code{upcase} is a character, @code{upcase}
817 returns the corresponding upper case character.  This value is an integer.
818 If the original character is upper case, or is not a letter, then the
819 value returned equals the original character.
821 @example
822 (upcase "The cat in the hat")
823      @result{} "THE CAT IN THE HAT"
825 (upcase ?x)
826      @result{} 88
827 @end example
828 @end defun
830 @defun capitalize string-or-char
831 @cindex capitalization
832 This function capitalizes strings or characters.  If
833 @var{string-or-char} is a string, the function creates and returns a new
834 string, whose contents are a copy of @var{string-or-char} in which each
835 word has been capitalized.  This means that the first character of each
836 word is converted to upper case, and the rest are converted to lower
837 case.
839 The definition of a word is any sequence of consecutive characters that
840 are assigned to the word constituent syntax class in the current syntax
841 table (@pxref{Syntax Class Table}).
843 When the argument to @code{capitalize} is a character, @code{capitalize}
844 has the same result as @code{upcase}.
846 @example
847 (capitalize "The cat in the hat")
848      @result{} "The Cat In The Hat"
850 (capitalize "THE 77TH-HATTED CAT")
851      @result{} "The 77th-Hatted Cat"
853 @group
854 (capitalize ?x)
855      @result{} 88
856 @end group
857 @end example
858 @end defun
860 @defun upcase-initials string
861 This function capitalizes the initials of the words in @var{string},
862 without altering any letters other than the initials.  It returns a new
863 string whose contents are a copy of @var{string}, in which each word has
864 had its initial letter converted to upper case.
866 The definition of a word is any sequence of consecutive characters that
867 are assigned to the word constituent syntax class in the current syntax
868 table (@pxref{Syntax Class Table}).
870 @example
871 @group
872 (upcase-initials "The CAT in the hAt")
873      @result{} "The CAT In The HAt"
874 @end group
875 @end example
876 @end defun
878   @xref{Text Comparison}, for functions that compare strings; some of
879 them ignore case differences, or can optionally ignore case differences.
881 @node Case Tables
882 @section The Case Table
884   You can customize case conversion by installing a special @dfn{case
885 table}.  A case table specifies the mapping between upper case and lower
886 case letters.  It affects both the case conversion functions for Lisp
887 objects (see the previous section) and those that apply to text in the
888 buffer (@pxref{Case Changes}).  Each buffer has a case table; there is
889 also a standard case table which is used to initialize the case table
890 of new buffers.
892   A case table is a char-table (@pxref{Char-Tables}) whose subtype is
893 @code{case-table}.  This char-table maps each character into the
894 corresponding lower case character.  It has three extra slots, which
895 hold related tables:
897 @table @var
898 @item upcase
899 The upcase table maps each character into the corresponding upper
900 case character.
901 @item canonicalize
902 The canonicalize table maps all of a set of case-related characters
903 into a particular member of that set.
904 @item equivalences
905 The equivalences table maps each one of a set of case-related characters
906 into the next character in that set.
907 @end table
909   In simple cases, all you need to specify is the mapping to lower-case;
910 the three related tables will be calculated automatically from that one.
912   For some languages, upper and lower case letters are not in one-to-one
913 correspondence.  There may be two different lower case letters with the
914 same upper case equivalent.  In these cases, you need to specify the
915 maps for both lower case and upper case.
917   The extra table @var{canonicalize} maps each character to a canonical
918 equivalent; any two characters that are related by case-conversion have
919 the same canonical equivalent character.  For example, since @samp{a}
920 and @samp{A} are related by case-conversion, they should have the same
921 canonical equivalent character (which should be either @samp{a} for both
922 of them, or @samp{A} for both of them).
924   The extra table @var{equivalences} is a map that cyclicly permutes
925 each equivalence class (of characters with the same canonical
926 equivalent).  (For ordinary @sc{ascii}, this would map @samp{a} into
927 @samp{A} and @samp{A} into @samp{a}, and likewise for each set of
928 equivalent characters.)
930   When you construct a case table, you can provide @code{nil} for
931 @var{canonicalize}; then Emacs fills in this slot from the lower case
932 and upper case mappings.  You can also provide @code{nil} for
933 @var{equivalences}; then Emacs fills in this slot from
934 @var{canonicalize}.  In a case table that is actually in use, those
935 components are non-@code{nil}.  Do not try to specify @var{equivalences}
936 without also specifying @var{canonicalize}.
938   Here are the functions for working with case tables:
940 @defun case-table-p object
941 This predicate returns non-@code{nil} if @var{object} is a valid case
942 table.
943 @end defun
945 @defun set-standard-case-table table
946 This function makes @var{table} the standard case table, so that it will
947 be used in any buffers created subsequently.
948 @end defun
950 @defun standard-case-table
951 This returns the standard case table.
952 @end defun
954 @defun current-case-table
955 This function returns the current buffer's case table.
956 @end defun
958 @defun set-case-table table
959 This sets the current buffer's case table to @var{table}.
960 @end defun
962   The following three functions are convenient subroutines for packages
963 that define non-@sc{ascii} character sets.  They modify the specified
964 case table @var{case-table}; they also modify the standard syntax table.
965 @xref{Syntax Tables}.  Normally you would use these functions to change
966 the standard case table.
968 @defun set-case-syntax-pair uc lc case-table
969 This function specifies a pair of corresponding letters, one upper case
970 and one lower case.
971 @end defun
973 @defun set-case-syntax-delims l r case-table
974 This function makes characters @var{l} and @var{r} a matching pair of
975 case-invariant delimiters.
976 @end defun
978 @defun set-case-syntax char syntax case-table
979 This function makes @var{char} case-invariant, with syntax
980 @var{syntax}.
981 @end defun
983 @deffn Command describe-buffer-case-table
984 This command displays a description of the contents of the current
985 buffer's case table.
986 @end deffn