annotate doc/lispref/strings.texi @ 84116:0ba80d073e27

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