annotate lispref/strings.texi @ 24283:6822ef19292a

*** empty log message ***
author Richard M. Stallman <rms@gnu.org>
date Mon, 08 Feb 1999 18:03:22 +0000
parents 40089afa2b1d
children 78aaef52e28f
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.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998 Free Software Foundation, Inc.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
4 @c See the file elisp.texi for copying conditions.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @setfilename ../info/strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 @node Strings and Characters, Lists, Numbers, Top
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
7 @comment node-name, next, previous, up
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @chapter Strings and Characters
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 @cindex strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 @cindex character arrays
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 @cindex characters
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 @cindex bytes
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 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
15 of characters. Strings are used as names of symbols, buffers, and
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 files, to send messages to users, to hold text being copied between
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 buffers, and for many other purposes. Because strings are so important,
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 Emacs Lisp has many functions expressly for manipulating them. Emacs
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19 Lisp programs use strings more often than individual characters.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 @xref{Strings of Events}, for special considerations for strings of
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 keyboard character events.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 @menu
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 * Basics: String Basics. Basic properties of strings and characters.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
26 * Predicates for Strings:: Testing whether an object is a string or char.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 * Creating Strings:: Functions to allocate new strings.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
28 * Modifying Strings:: Altering the contents of an existing string.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 * Text Comparison:: Comparing characters or strings.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30 * String Conversion:: Converting characters or strings and vice versa.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
31 * 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
32 * Case Conversion:: Case conversion functions.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
33 * Case Tables:: Customizing case conversion.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 @end menu
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 @node String Basics
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 @section String and Character Basics
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
38
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 Strings in Emacs Lisp are arrays that contain an ordered sequence of
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 characters. 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
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
47 C are terminated by a character with @sc{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
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
55 There are two text representations for non-@sc{ASCII} characters in
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
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
57 Representations}). @sc{ASCII} characters always occupy one byte in a
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
58 string; in fact, there is no real difference between the two
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
59 representation for a string which is all @sc{ASCII}. For most Lisp
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
60 programming, you don't need to be concerned with these two
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
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
65 characters (which are extremely large integers) rather than character
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
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
69 modifiers; they can hold @sc{ASCII} control characters, but no other
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 control characters. They do not distinguish case in @sc{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.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
73 @xref{Character Type}, for more information about representation of meta
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
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
77 match regular expressions against strings (@pxref{Regexp Search}). The
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
78 functions @code{match-string} (@pxref{Simple Match Data}) and
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
79 @code{replace-match} (@pxref{Replacing Match}) are useful for
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
80 decomposing and modifying strings based on regular expression matching.
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
81
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
82 Like a buffer, a string can contain text properties for the characters
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
83 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
84 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
85 strings also copy the properties of the characters being copied.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
86
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
87 @xref{Text}, for information about functions that display strings or
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88 copy them into buffers. @xref{Character Type}, and @ref{String Type},
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
89 for information about the syntax of characters and strings.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
90 @xref{Non-ASCII Characters}, for functions to convert between text
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
91 representations and encode and decode character codes.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
92
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
93 @node Predicates for Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
94 @section The Predicates for Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
95
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
96 For more information about general sequence and array predicates,
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
97 see @ref{Sequences Arrays Vectors}, and @ref{Arrays}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
98
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
99 @defun stringp object
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
100 This function returns @code{t} if @var{object} is a string, @code{nil}
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
101 otherwise.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
102 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 @defun char-or-string-p object
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
105 This function returns @code{t} if @var{object} is a string or a
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
106 character (i.e., an integer), @code{nil} otherwise.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
107 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
108
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
109 @node Creating Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
110 @section Creating Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 The following functions create strings, either from scratch, or by
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 putting strings together, or by taking them apart.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 @defun make-string count character
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
116 This function returns a string made up of @var{count} repetitions of
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
117 @var{character}. If @var{count} is negative, an error is signaled.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 (make-string 5 ?x)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121 @result{} "xxxxx"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 (make-string 0 ?x)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
123 @result{} ""
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126 Other functions to compare with this one include @code{char-to-string}
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
127 (@pxref{String Conversion}), @code{make-vector} (@pxref{Vectors}), and
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
128 @code{make-list} (@pxref{Building Lists}).
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
129 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
130
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
131 @defun string &rest characters
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
132 @tindex string
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
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
162 signifies the index of the last character of the string. For example:
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
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
176 When @code{nil} is used as an index, it stands for the length of the
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
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
204 @code{substring} also allows vectors for the first argument.
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
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
212 A @code{wrong-type-argument} error is signaled if either @var{start} or
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
213 @var{end} is not an integer or @code{nil}. An @code{args-out-of-range}
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
214 error is signaled if @var{start} indicates a character following
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
215 @var{end}, or if either integer is out of range for @var{string}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
216
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
217 Contrast this function with @code{buffer-substring} (@pxref{Buffer
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218 Contents}), which returns a string containing a portion of the text in
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
219 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
220 beginning of a buffer is at index 1.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 @defun concat &rest sequences
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
224 @cindex copying strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
225 @cindex concatenating strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
226 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
227 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
228 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
229 are not themselves changed. If @code{concat} receives no arguments, it
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
230 returns an empty string.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
231
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
232 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
233 (concat "abc" "-def")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
234 @result{} "abc-def"
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
235 (concat "abc" (list 120 121) [122])
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
236 @result{} "abcxyz"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
237 ;; @r{@code{nil} is an empty sequence.}
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
238 (concat "abc" nil "-def")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
239 @result{} "abc-def"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
240 (concat "The " "quick brown " "fox.")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241 @result{} "The quick brown fox."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
242 (concat)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
243 @result{} ""
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
244 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
245
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
246 @noindent
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
247 The @code{concat} function always constructs a new string that is
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
248 not @code{eq} to any existing string.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
249
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
250 When an argument is an integer (not a sequence of integers), it is
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
251 converted to a string of digits making up the decimal printed
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 11141
diff changeset
252 representation of the integer. @strong{Don't use this feature; we plan
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 11141
diff changeset
253 to eliminate it. If you already use this feature, change your programs
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 11141
diff changeset
254 now!} The proper way to convert an integer to a decimal number in this
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 11141
diff changeset
255 way 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
256 @code{number-to-string} (@pxref{String Conversion}).
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
257
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
258 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
259 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
260 (concat 137)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
261 @result{} "137"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
262 (concat 54 321)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
263 @result{} "54321"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
264 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
265 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
266
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267 For information about other concatenation functions, see the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268 description of @code{mapconcat} in @ref{Mapping Functions},
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
269 @code{vconcat} in @ref{Vectors}, and @code{append} in @ref{Building
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
270 Lists}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
271 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
272
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
273 @defun split-string string separators
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
274 @tindex split-string
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
275 Split @var{string} into substrings in between matches for the regular
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
276 expression @var{separators}. Each match for @var{separators} defines a
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
277 splitting point; the substrings between the splitting points are made
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
278 into a list, which is the value. If @var{separators} is @code{nil} (or
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
279 omitted), the default is @code{"[ \f\t\n\r\v]+"}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
280
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
281 For example,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
282
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
283 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
284 (split-string "Soup is good food" "o")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
285 @result{} ("S" "up is g" "" "d f" "" "d")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
286 (split-string "Soup is good food" "o+")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
287 @result{} ("S" "up is g" "d f" "d")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
288 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
289
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
290 When there is a match adjacent to the beginning or end of the string,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
291 this does not cause a null string to appear at the beginning or end
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
292 of the list:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
293
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
294 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
295 (split-string "out to moo" "o+")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
296 @result{} ("ut t" " m")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
297 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
298
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
299 Empty matches do count, when not adjacent to another match:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
300
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
301 @example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
302 (split-string "Soup is good food" "o*")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
303 @result{}("S" "u" "p" " " "i" "s" " " "g" "d" " " "f" "d")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
304 (split-string "Nice doggy!" "")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
305 @result{}("N" "i" "c" "e" " " "d" "o" "g" "g" "y" "!")
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
306 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
307 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
308
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
309 @node Modifying Strings
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
310 @section Modifying Strings
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
311
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
312 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
313 @code{aset} (@pxref{Array Functions}). @code{(aset @var{string}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
314 @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
315 @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
316 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
317 that index, @code{aset} signals an error.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
318
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
319 A more powerful function is @code{store-substring}:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
320
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
321 @defun store-substring string idx obj
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
322 @tindex store-substring
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
323 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
324 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
325 may be either a character or a (smaller) string.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
326
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
327 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
328 an error if @var{obj} doesn't fit within @var{string}'s actual length,
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
329 of if any new character requires a different number of bytes from the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
330 character currently present at that point in @var{string}.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
331 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
332
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
333 @need 2000
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
334 @node Text Comparison
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
335 @section Comparison of Characters and Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
336 @cindex string equality
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
337
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
338 @defun char-equal character1 character2
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
339 This function returns @code{t} if the arguments represent the same
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
340 character, @code{nil} otherwise. This function ignores differences
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
341 in case if @code{case-fold-search} is non-@code{nil}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
342
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
343 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
344 (char-equal ?x ?x)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
345 @result{} t
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
346 (let ((case-fold-search nil))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
347 (char-equal ?x ?X))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
348 @result{} nil
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
349 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
350 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
351
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
352 @defun string= string1 string2
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
353 This function returns @code{t} if the characters of the two strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
354 match exactly; case is significant.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
355
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
356 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
357 (string= "abc" "abc")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
358 @result{} t
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
359 (string= "abc" "ABC")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
360 @result{} nil
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
361 (string= "ab" "ABC")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
362 @result{} nil
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
363 @end example
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 11141
diff changeset
364
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
365 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
366 strings. When @code{equal} (@pxref{Equality Predicates}) compares two
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
367 strings, it uses @code{string=}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
368
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
369 If the strings contain non-@sc{ASCII} characters, and one is unibyte
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
370 while the other is multibyte, then they cannot be equal. @xref{Text
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
371 Representations}.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
372 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374 @defun string-equal string1 string2
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
375 @code{string-equal} is another name for @code{string=}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
377
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
378 @cindex lexical comparison
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379 @defun string< string1 string2
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 @c (findex string< causes problems for permuted index!!)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 This function compares two strings a character at a time. First it
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382 scans both the strings at once to find the first pair of corresponding
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 characters that do not match. If the lesser character of those two is
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 the character from @var{string1}, then @var{string1} is less, and this
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 function returns @code{t}. If the lesser character is the one from
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386 @var{string2}, then @var{string1} is greater, and this function returns
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387 @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
388
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
389 Pairs of characters are compared according to their character codes.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
390 Keep in mind that lower case letters have higher numeric values in the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
391 @sc{ASCII} character set than their upper case counterparts; digits and
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
392 many punctuation characters have a lower numeric value than upper case
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
393 letters. An @sc{ASCII} character is less than any non-@sc{ASCII}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
394 character; a unibyte non-@sc{ASCII} character is always less than any
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
395 multibyte non-@sc{ASCII} character (@pxref{Text Representations}).
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 (string< "abc" "abd")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400 @result{} t
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401 (string< "abd" "abc")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 @result{} nil
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 (string< "123" "abc")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
404 @result{} t
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 When the strings have different lengths, and they match up to the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 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
410 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
411 no characters is less than any other string.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 (string< "" "abc")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 @result{} t
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
417 (string< "ab" "abc")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
418 @result{} t
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 (string< "abc" "")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 @result{} nil
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 (string< "abc" "ab")
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< "" "")
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 group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
428
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
429 @defun string-lessp string1 string2
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
430 @code{string-lessp} is another name for @code{string<}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
431 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
432
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
433 @defun compare-strings string1 start1 end1 string2 start2 end2 &optional ignore-case
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
434 @tindex compare-strings
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
435 This function compares a specified part of @var{string1} with a
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
436 specified part of @var{string2}. The specified part of @var{string1}
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
437 runs from index @var{start1} up to index @var{end1} (default, the end of
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
438 the string). The specified part of @var{string2} runs from index
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
439 @var{start2} up to index @var{end2} (default, the end of the string).
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
440
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
441 The strings are both converted to multibyte for the comparison
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
442 (@pxref{Text Representations}) so that a unibyte string can be equal to
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
443 a multibyte string. If @var{ignore-case} is non-@code{nil}, then case
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
444 is ignored, so that 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
445
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
446 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
447 @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
448 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
449 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
450 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
451 portion) is less.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
452 @end defun
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
453
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
454 @defun assoc-ignore-case key alist
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
455 @tindex assoc-ignore-case
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
456 This function works like @code{assoc}, except that @var{key} must be a
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
457 string, and comparison is done using @code{compare-strings}.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
458 Case differences are ignored in this comparison.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
459 @end defun
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
460
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
461 @defun assoc-ignore-representation key alist
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
462 @tindex assoc-ignore-representation
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
463 This function works like @code{assoc}, except that @var{key} must be a
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
464 string, and comparison is done using @code{compare-strings}.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
465 Case differences are significant.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
466 @end defun
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
467
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 See also @code{compare-buffer-substrings} in @ref{Comparing Text}, for
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 a way to compare text in buffers. The function @code{string-match},
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470 which matches a regular expression against a string, can be used
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 for a kind of string comparison; see @ref{Regexp Search}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 @node String Conversion
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474 @comment node-name, next, previous, up
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475 @section Conversion of Characters and Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 @cindex conversion of strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478 This section describes functions for conversions between characters,
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 strings and integers. @code{format} and @code{prin1-to-string}
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480 (@pxref{Output Functions}) can also convert Lisp objects into strings.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 @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
482 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
483 @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
484 text representation of a string (@pxref{Converting Representations}).
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 @xref{Documentation}, for functions that produce textual descriptions
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487 of text characters and general input events
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488 (@code{single-key-description} and @code{text-char-description}). These
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489 functions are used primarily for making help messages.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491 @defun char-to-string character
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 @cindex character to string
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
493 This function returns a new string containing one character,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
494 @var{character}. This function is semi-obsolete because the function
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
495 @code{string} is more general. @xref{Creating Strings}.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 @defun string-to-char string
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 @cindex string to character
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 This function returns the first character in @var{string}. If the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501 string is empty, the function returns 0. The value is also 0 when the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
502 first character of @var{string} is the null character, @sc{ASCII} code
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
503 0.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
504
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
505 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
506 (string-to-char "ABC")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
507 @result{} 65
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
508 (string-to-char "xyz")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
509 @result{} 120
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
510 (string-to-char "")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
511 @result{} 0
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 (string-to-char "\000")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513 @result{} 0
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
516 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
517 enough to retain.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
518 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
519
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520 @defun number-to-string number
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
521 @cindex integer to string
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522 @cindex integer to decimal
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
523 This function returns a string consisting of the printed
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
524 representation of @var{number}, which may be an integer or a floating
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
525 point number. The value starts with a sign if the argument is
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
526 negative.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
527
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
529 (number-to-string 256)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 @result{} "256"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 (number-to-string -23)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 @result{} "-23"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533 (number-to-string -23.5)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 @result{} "-23.5"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 @cindex int-to-string
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 @code{int-to-string} is a semi-obsolete alias for this function.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
540 See also the function @code{format} in @ref{Formatting Strings}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
541 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
542
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
543 @defun string-to-number string &optional base
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 @cindex string to number
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545 This function returns the numeric value of the characters in
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
546 @var{string}. If @var{base} is non-@code{nil}, integers are converted
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
547 in that base. If @var{base} is @code{nil}, then base ten is used.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
548 Floating point conversion always uses base ten; we have not implemented
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
549 other radices for floating point numbers, because that would be much
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
550 more work and does not seem useful.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
551
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
552 The parsing skips spaces and tabs at the beginning of @var{string}, then
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
553 reads as much of @var{string} as it can interpret as a number. (On some
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
554 systems it ignores other whitespace at the beginning, not just spaces
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
555 and tabs.) If the first character after the ignored whitespace is not a
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
556 digit or a plus or minus sign, this function returns 0.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
558 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
559 (string-to-number "256")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
560 @result{} 256
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
561 (string-to-number "25 is a perfect square.")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
562 @result{} 25
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
563 (string-to-number "X256")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564 @result{} 0
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
565 (string-to-number "-4.5")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 @result{} -4.5
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 @findex string-to-int
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 @code{string-to-int} is an obsolete alias for this function.
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
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
573 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
574
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
575 @table @code
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
576 @item concat
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
577 @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
578 @xref{Creating Strings}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
579
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
580 @item vconcat
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
581 @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
582 Functions}.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
583
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
584 @item append
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
585 @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
586 @end table
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
587
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 @node Formatting Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589 @comment node-name, next, previous, up
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590 @section Formatting Strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591 @cindex formatting strings
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 @cindex strings, formatting them
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594 @dfn{Formatting} means constructing a string by substitution of
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595 computed values at various places in a constant string. This string
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 controls how the other values are printed as well as where they appear;
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597 it is called a @dfn{format string}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
598
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 Formatting is often useful for computing messages to be displayed. In
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600 fact, the functions @code{message} and @code{error} provide the same
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 formatting feature described here; they differ from @code{format} only
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
602 in how they use the result of formatting.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
603
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
604 @defun format string &rest objects
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
605 This function returns a new string that is made by copying
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606 @var{string} and then replacing any format specification
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 in the copy with encodings of the corresponding @var{objects}. The
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 arguments @var{objects} are the computed values to be formatted.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611 @cindex @samp{%} in format
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 @cindex format specification
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 A format specification is a sequence of characters beginning with a
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 @samp{%}. Thus, if there is a @samp{%d} in @var{string}, the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615 @code{format} function replaces it with the printed representation of
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 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
617 For example:
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 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621 (format "The value of fill-column is %d." fill-column)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 @result{} "The value of fill-column is 72."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 If @var{string} contains more than one format specification, the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627 format specifications correspond with successive values from
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 @var{objects}. Thus, the first format specification in @var{string}
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629 uses the first such value, the second format specification uses the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630 second such value, and so on. Any extra format specifications (those
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631 for which there are no corresponding values) cause unpredictable
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 behavior. Any extra values to be formatted are ignored.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
634 Certain format specifications require values of particular types. If
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
635 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
636 signaled.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 Here is a table of valid format specifications:
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 @table @samp
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641 @item %s
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 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
643 made without quoting (that is, using @code{princ}, not
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
644 @code{prin1}---@pxref{Output Functions}). Thus, strings are represented
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
645 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
646 without @samp{\} characters.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
648 If there is no corresponding object, the empty string is used.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 @item %S
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651 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
652 made with quoting (that is, using @code{prin1}---@pxref{Output
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
653 Functions}). Thus, strings are enclosed in @samp{"} characters, and
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
654 @samp{\} characters appear where necessary before special characters.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656 If there is no corresponding object, the empty string is used.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658 @item %o
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659 @cindex integer to octal
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660 Replace the specification with the base-eight representation of an
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 integer.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 @item %d
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 Replace the specification with the base-ten representation of an
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 integer.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
667 @item %x
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668 @cindex integer to hexadecimal
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 Replace the specification with the base-sixteen representation of an
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 integer.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 @item %c
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 Replace the specification with the character which is the value given.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 @item %e
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 Replace the specification with the exponential notation for a floating
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677 point number.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
678
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
679 @item %f
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
680 Replace the specification with the decimal-point notation for a floating
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
681 point number.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
682
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
683 @item %g
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 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
685 using either exponential notation or decimal-point notation, whichever
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 is shorter.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 @item %%
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 A single @samp{%} is placed in the string. This format specification is
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690 unusual in that it does not use a value. For example, @code{(format "%%
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 %d" 30)} returns @code{"% 30"}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 @end table
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 Any other format character results in an @samp{Invalid format
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695 operation} error.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 Here are several examples:
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
701 (format "The name of this buffer is %s." (buffer-name))
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
702 @result{} "The name of this buffer is strings.texi."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704 (format "The buffer object prints as %s." (current-buffer))
13228
a4a1d7df2e7f Fix format example.
Richard M. Stallman <rms@gnu.org>
parents: 12282
diff changeset
705 @result{} "The buffer object prints as strings.texi."
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707 (format "The octal value of %d is %o,
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 and the hex value is %x." 18 18 18)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709 @result{} "The octal value of 18 is 22,
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 and the hex value is 12."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714 @cindex numeric prefix
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 @cindex field width
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
716 @cindex padding
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
717 All the specification characters allow an optional numeric prefix
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
718 between the @samp{%} and the character. The optional numeric prefix
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
719 defines the minimum width for the object. If the printed representation
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
720 of the object contains fewer characters than this, then it is padded.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
721 The padding is on the left if the prefix is positive (or starts with
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
722 zero) and on the right if the prefix is negative. The padding character
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
723 is normally a space, but if the numeric prefix starts with a zero, zeros
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
724 are used for padding. Here are some examples of padding:
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
725
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
726 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
727 (format "%06d is padded on the left with zeros" 123)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
728 @result{} "000123 is padded on the left with zeros"
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 (format "%-6d is padded on the right" 123)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
731 @result{} "123 is padded on the right"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
732 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
733
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
734 @code{format} never truncates an object's printed representation, no
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
735 matter what width you specify. Thus, you can use a numeric prefix to
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
736 specify a minimum spacing between columns with no risk of losing
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
737 information.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
738
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
739 In the following three examples, @samp{%7s} specifies a minimum width
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
740 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
741 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
742 second case, the string @code{"specification"} is 13 letters wide but is
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
743 not truncated. In the third case, the padding is on the right.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
744
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
745 @smallexample
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
746 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
747 (format "The word `%7s' actually has %d letters in it."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
748 "foo" (length "foo"))
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
749 @result{} "The word ` foo' actually has 3 letters in it."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
750 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
751
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
752 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
753 (format "The word `%7s' actually has %d letters in it."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
754 "specification" (length "specification"))
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
755 @result{} "The word `specification' actually has 13 letters in it."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
756 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
757
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
758 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
759 (format "The word `%-7s' actually has %d letters in it."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
760 "foo" (length "foo"))
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
761 @result{} "The word `foo ' actually has 3 letters in it."
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
762 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763 @end smallexample
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
765 @node Case Conversion
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
766 @comment node-name, next, previous, up
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
767 @section Case Conversion in Lisp
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
768 @cindex upper case
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769 @cindex lower case
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
770 @cindex character case
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
771 @cindex case conversion in Lisp
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
772
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
773 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
774 of the contents of strings. The functions normally convert only
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
775 alphabetic characters (the letters @samp{A} through @samp{Z} and
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
776 @samp{a} through @samp{z}, as well as non-ASCII letters); other
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
777 characters are not altered. (You can specify a different case
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
778 conversion mapping by specifying a case table---@pxref{Case Tables}.)
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
779
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
780 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
781 arguments.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
782
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
783 The examples below use the characters @samp{X} and @samp{x} which have
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
784 @sc{ASCII} codes 88 and 120 respectively.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
785
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
786 @defun downcase string-or-char
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
787 This function converts a character or a string to lower case.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
788
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
789 When the argument to @code{downcase} is a string, the function creates
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
790 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
791 upper case is converted to lower case. When the argument to
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
792 @code{downcase} is a character, @code{downcase} returns the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
793 corresponding lower case character. This value is an integer. If the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
794 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
795 equals the original character.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
796
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
797 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
798 (downcase "The cat in the hat")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799 @result{} "the cat in the hat"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801 (downcase ?X)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
802 @result{} 120
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 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806 @defun upcase string-or-char
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807 This function converts a character or a string to upper case.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809 When the argument to @code{upcase} is a string, the function creates
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810 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
811 lower case is converted to upper case.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
812
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813 When the argument to @code{upcase} is a character, @code{upcase}
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814 returns the corresponding upper case character. This value is an integer.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
815 If the original character is upper case, or is not a letter, then the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
816 value equals the original character.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
817
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 (upcase "The cat in the hat")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
820 @result{} "THE CAT IN THE HAT"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
821
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
822 (upcase ?x)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
823 @result{} 88
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 @defun capitalize string-or-char
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
828 @cindex capitalization
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829 This function capitalizes strings or characters. If
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
830 @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
831 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
832 word has been capitalized. This means that the first character of each
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833 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
834 case.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836 The definition of a word is any sequence of consecutive characters that
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
837 are assigned to the word constituent syntax class in the current syntax
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
838 table (@xref{Syntax Class Table}).
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
839
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
840 When the argument to @code{capitalize} is a character, @code{capitalize}
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
841 has the same result as @code{upcase}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
842
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843 @example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
844 (capitalize "The cat in the hat")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
845 @result{} "The Cat In The Hat"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
846
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
847 (capitalize "THE 77TH-HATTED CAT")
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
848 @result{} "The 77th-Hatted Cat"
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
849
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
850 @group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851 (capitalize ?x)
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852 @result{} 88
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
853 @end group
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
854 @end example
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
855 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
857 @defun upcase-initials string
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
858 This function capitalizes the initials of the words in @var{string}.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
859 without altering any letters other than the initials. It returns a new
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
860 string whose contents are a copy of @var{string}, in which each word has
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
861 been converted to upper case.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
862
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
863 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
864 are assigned to the word constituent syntax class in the current syntax
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
865 table (@xref{Syntax Class Table}).
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
866
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
867 @example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
868 @group
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
869 (upcase-initials "The CAT in the hAt")
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
870 @result{} "The CAT In The HAt"
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
871 @end group
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
872 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
873 @end defun
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
874
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
875 @xref{Text Comparison}, for functions that compare strings; some of
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
876 them ignore case differences, or can optionally ignore case differences.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
877
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
878 @node Case Tables
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
879 @section The Case Table
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
880
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
881 You can customize case conversion by installing a special @dfn{case
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
882 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
883 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
884 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
885 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
886 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
887 of new buffers.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
888
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
889 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
890 @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
891 corresponding lower case character. It has three extra slots, which
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
892 hold related tables:
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
894 @table @var
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
895 @item upcase
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
896 The upcase table maps each character into the corresponding upper
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
897 case character.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
898 @item canonicalize
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
899 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
900 into a particular member of that set.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
901 @item equivalences
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
902 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
903 into the next character in that set.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
904 @end table
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
906 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
907 the three related tables will be calculated automatically from that one.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
908
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
909 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
910 correspondence. There may be two different lower case letters with the
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911 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
912 maps for both lower case and upper case.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
913
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
914 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
915 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
916 the same canonical equivalent character. For example, since @samp{a}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
917 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
918 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
919 of them, or @samp{A} for both of them).
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
920
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
921 The extra table @var{equivalences} is a map that cyclicly permutes
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
922 each equivalence class (of characters with the same canonical
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
923 equivalent). (For ordinary @sc{ASCII}, this would map @samp{a} into
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
924 @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
925 equivalent characters.)
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
926
6938
782646fc7505 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6550
diff changeset
927 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
928 @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
929 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
930 @var{equivalences}; then Emacs fills in this slot from
6938
782646fc7505 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 6550
diff changeset
931 @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
932 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
933 without also specifying @var{canonicalize}.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
934
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
935 Here are the functions for working with case tables:
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 @defun case-table-p object
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938 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
939 table.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
940 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
941
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
942 @defun set-standard-case-table table
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
943 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
944 be used in any buffers created subsequently.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
945 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
946
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
947 @defun standard-case-table
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
948 This returns the standard case table.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
949 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
950
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951 @defun current-case-table
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952 This function returns the current buffer's case table.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953 @end defun
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 @defun set-case-table table
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
956 This sets the current buffer's case table to @var{table}.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
957 @end defun
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 The following three functions are convenient subroutines for packages
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
960 that define non-@sc{ASCII} character sets. They modify the specified
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
961 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
962 @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
963 the standard case table.
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
964
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
965 @defun set-case-syntax-pair uc lc case-table
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
966 This function specifies a pair of corresponding letters, one upper case
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
967 and one lower case.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
968 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
969
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
970 @defun set-case-syntax-delims l r case-table
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
971 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
972 case-invariant delimiters.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
973 @end defun
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
974
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 13228
diff changeset
975 @defun set-case-syntax char syntax case-table
6550
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
976 This function makes @var{char} case-invariant, with syntax
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
977 @var{syntax}.
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
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
980 @deffn Command describe-buffer-case-table
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
981 This command displays a description of the contents of the current
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
982 buffer's case table.
e3f5cba23198 Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
983 @end deffn