annotate doc/lispref/strings.texi @ 112409:0222e3f822e3

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