annotate lispref/strings.texi @ 66584:9600fc8cfb65

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