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