Mercurial > emacs
annotate lispref/searching.texi @ 38564:65c2f5d8dfa9
*** empty log message ***
author | Gerd Moellmann <gerd@gnu.org> |
---|---|
date | Wed, 25 Jul 2001 17:42:56 +0000 |
parents | 2b1f94f72990 |
children | 53166863c34a |
rev | line source |
---|---|
6552 | 1 @c -*-texinfo-*- |
2 @c This is part of the GNU Emacs Lisp Reference Manual. | |
27189 | 3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999 |
4 @c Free Software Foundation, Inc. | |
6552 | 5 @c See the file elisp.texi for copying conditions. |
6 @setfilename ../info/searching | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
7 @node Searching and Matching, Syntax Tables, Non-ASCII Characters, Top |
6552 | 8 @chapter Searching and Matching |
9 @cindex searching | |
10 | |
11 GNU Emacs provides two ways to search through a buffer for specified | |
12 text: exact string searches and regular expression searches. After a | |
13 regular expression search, you can examine the @dfn{match data} to | |
14 determine which text matched the whole regular expression or various | |
15 portions of it. | |
16 | |
17 @menu | |
18 * String Search:: Search for an exact match. | |
19 * Regular Expressions:: Describing classes of strings. | |
20 * Regexp Search:: Searching for a match for a regexp. | |
12067 | 21 * POSIX Regexps:: Searching POSIX-style for the longest match. |
6552 | 22 * Search and Replace:: Internals of @code{query-replace}. |
23 * Match Data:: Finding out which part of the text matched | |
24 various parts of a regexp, after regexp search. | |
25 * Searching and Case:: Case-independent or case-significant searching. | |
26 * Standard Regexps:: Useful regexps for finding sentences, pages,... | |
27 @end menu | |
28 | |
29 The @samp{skip-chars@dots{}} functions also perform a kind of searching. | |
30 @xref{Skipping Characters}. | |
31 | |
32 @node String Search | |
33 @section Searching for Strings | |
34 @cindex string search | |
35 | |
36 These are the primitive functions for searching through the text in a | |
37 buffer. They are meant for use in programs, but you may call them | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
38 interactively. If you do so, they prompt for the search string; the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
39 arguments @var{limit} and @var{noerror} are @code{nil}, and @var{repeat} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
40 is 1. |
6552 | 41 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
42 These search functions convert the search string to multibyte if the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
43 buffer is multibyte; they convert the search string to unibyte if the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
44 buffer is unibyte. @xref{Text Representations}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
45 |
6552 | 46 @deffn Command search-forward string &optional limit noerror repeat |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
47 This function searches forward from point for an exact match for |
6552 | 48 @var{string}. If successful, it sets point to the end of the occurrence |
49 found, and returns the new value of point. If no match is found, the | |
50 value and side effects depend on @var{noerror} (see below). | |
51 @c Emacs 19 feature | |
52 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
53 In the following example, point is initially at the beginning of the |
6552 | 54 line. Then @code{(search-forward "fox")} moves point after the last |
55 letter of @samp{fox}: | |
56 | |
57 @example | |
58 @group | |
59 ---------- Buffer: foo ---------- | |
60 @point{}The quick brown fox jumped over the lazy dog. | |
61 ---------- Buffer: foo ---------- | |
62 @end group | |
63 | |
64 @group | |
65 (search-forward "fox") | |
66 @result{} 20 | |
67 | |
68 ---------- Buffer: foo ---------- | |
69 The quick brown fox@point{} jumped over the lazy dog. | |
70 ---------- Buffer: foo ---------- | |
71 @end group | |
72 @end example | |
73 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
74 The argument @var{limit} specifies the upper bound to the search. (It |
6552 | 75 must be a position in the current buffer.) No match extending after |
76 that position is accepted. If @var{limit} is omitted or @code{nil}, it | |
77 defaults to the end of the accessible portion of the buffer. | |
78 | |
79 @kindex search-failed | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
80 What happens when the search fails depends on the value of |
6552 | 81 @var{noerror}. If @var{noerror} is @code{nil}, a @code{search-failed} |
82 error is signaled. If @var{noerror} is @code{t}, @code{search-forward} | |
83 returns @code{nil} and does nothing. If @var{noerror} is neither | |
84 @code{nil} nor @code{t}, then @code{search-forward} moves point to the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
85 upper bound and returns @code{nil}. (It would be more consistent now to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
86 return the new position of point in that case, but some existing |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
87 programs may depend on a value of @code{nil}.) |
6552 | 88 |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
89 If @var{repeat} is supplied (it must be a positive number), then the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
90 search is repeated that many times (each time starting at the end of the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
91 previous time's match). If these successive searches succeed, the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
92 function succeeds, moving point and returning its new value. Otherwise |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
93 the search fails. |
6552 | 94 @end deffn |
95 | |
96 @deffn Command search-backward string &optional limit noerror repeat | |
97 This function searches backward from point for @var{string}. It is | |
98 just like @code{search-forward} except that it searches backwards and | |
99 leaves point at the beginning of the match. | |
100 @end deffn | |
101 | |
102 @deffn Command word-search-forward string &optional limit noerror repeat | |
103 @cindex word search | |
104 This function searches forward from point for a ``word'' match for | |
105 @var{string}. If it finds a match, it sets point to the end of the | |
106 match found, and returns the new value of point. | |
107 @c Emacs 19 feature | |
108 | |
109 Word matching regards @var{string} as a sequence of words, disregarding | |
110 punctuation that separates them. It searches the buffer for the same | |
111 sequence of words. Each word must be distinct in the buffer (searching | |
112 for the word @samp{ball} does not match the word @samp{balls}), but the | |
113 details of punctuation and spacing are ignored (searching for @samp{ball | |
114 boy} does match @samp{ball. Boy!}). | |
115 | |
116 In this example, point is initially at the beginning of the buffer; the | |
117 search leaves it between the @samp{y} and the @samp{!}. | |
118 | |
119 @example | |
120 @group | |
121 ---------- Buffer: foo ---------- | |
122 @point{}He said "Please! Find | |
123 the ball boy!" | |
124 ---------- Buffer: foo ---------- | |
125 @end group | |
126 | |
127 @group | |
128 (word-search-forward "Please find the ball, boy.") | |
129 @result{} 35 | |
130 | |
131 ---------- Buffer: foo ---------- | |
132 He said "Please! Find | |
133 the ball boy@point{}!" | |
134 ---------- Buffer: foo ---------- | |
135 @end group | |
136 @end example | |
137 | |
138 If @var{limit} is non-@code{nil} (it must be a position in the current | |
139 buffer), then it is the upper bound to the search. The match found must | |
140 not extend after that position. | |
141 | |
142 If @var{noerror} is @code{nil}, then @code{word-search-forward} signals | |
143 an error if the search fails. If @var{noerror} is @code{t}, then it | |
144 returns @code{nil} instead of signaling an error. If @var{noerror} is | |
145 neither @code{nil} nor @code{t}, it moves point to @var{limit} (or the | |
146 end of the buffer) and returns @code{nil}. | |
147 | |
148 If @var{repeat} is non-@code{nil}, then the search is repeated that many | |
149 times. Point is positioned at the end of the last match. | |
150 @end deffn | |
151 | |
152 @deffn Command word-search-backward string &optional limit noerror repeat | |
153 This function searches backward from point for a word match to | |
154 @var{string}. This function is just like @code{word-search-forward} | |
155 except that it searches backward and normally leaves point at the | |
156 beginning of the match. | |
157 @end deffn | |
158 | |
159 @node Regular Expressions | |
160 @section Regular Expressions | |
161 @cindex regular expression | |
162 @cindex regexp | |
163 | |
164 A @dfn{regular expression} (@dfn{regexp}, for short) is a pattern that | |
165 denotes a (possibly infinite) set of strings. Searching for matches for | |
166 a regexp is a very powerful operation. This section explains how to write | |
167 regexps; the following section says how to search for them. | |
168 | |
169 @menu | |
170 * Syntax of Regexps:: Rules for writing regular expressions. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
171 * Regexp Functions:: Functions for operating on regular expressions. |
6552 | 172 * Regexp Example:: Illustrates regular expression syntax. |
173 @end menu | |
174 | |
175 @node Syntax of Regexps | |
176 @subsection Syntax of Regular Expressions | |
177 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
178 Regular expressions have a syntax in which a few characters are |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
179 special constructs and the rest are @dfn{ordinary}. An ordinary |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
180 character is a simple regular expression that matches that character and |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
181 nothing else. The special characters are @samp{.}, @samp{*}, @samp{+}, |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
182 @samp{?}, @samp{[}, @samp{]}, @samp{^}, @samp{$}, and @samp{\}; no new |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
183 special characters will be defined in the future. Any other character |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
184 appearing in a regular expression is ordinary, unless a @samp{\} |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
185 precedes it. |
6552 | 186 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
187 For example, @samp{f} is not a special character, so it is ordinary, and |
6552 | 188 therefore @samp{f} is a regular expression that matches the string |
189 @samp{f} and no other string. (It does @emph{not} match the string | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
190 @samp{fg}, but it does match a @emph{part} of that string.) Likewise, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
191 @samp{o} is a regular expression that matches only @samp{o}.@refill |
6552 | 192 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
193 Any two regular expressions @var{a} and @var{b} can be concatenated. The |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
194 result is a regular expression that matches a string if @var{a} matches |
6552 | 195 some amount of the beginning of that string and @var{b} matches the rest of |
196 the string.@refill | |
197 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
198 As a simple example, we can concatenate the regular expressions @samp{f} |
6552 | 199 and @samp{o} to get the regular expression @samp{fo}, which matches only |
200 the string @samp{fo}. Still trivial. To do something more powerful, you | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
201 need to use one of the special regular expression constructs. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
202 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
203 @menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
204 * Regexp Special:: Special characters in regular expressions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
205 * Char Classes:: Character classes used in regular expressions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
206 * Regexp Backslash:: Backslash-sequences in regular expressions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
207 @end menu |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
208 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
209 @node Regexp Special |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
210 @subsubsection Special Characters in Regular Expressions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
211 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
212 Here is a list of the characters that are special in a regular |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
213 expression. |
6552 | 214 |
22274
f0cd03a7dac9
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22252
diff
changeset
|
215 @need 800 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
216 @table @asis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
217 @item @samp{.}@: @r{(Period)} |
6552 | 218 @cindex @samp{.} in regexp |
219 is a special character that matches any single character except a newline. | |
220 Using concatenation, we can make regular expressions like @samp{a.b}, which | |
221 matches any three-character string that begins with @samp{a} and ends with | |
222 @samp{b}.@refill | |
223 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
224 @item @samp{*} |
6552 | 225 @cindex @samp{*} in regexp |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
226 is not a construct by itself; it is a postfix operator that means to |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
227 match the preceding regular expression repetitively as many times as |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
228 possible. Thus, @samp{o*} matches any number of @samp{o}s (including no |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
229 @samp{o}s). |
6552 | 230 |
231 @samp{*} always applies to the @emph{smallest} possible preceding | |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
232 expression. Thus, @samp{fo*} has a repeating @samp{o}, not a repeating |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
233 @samp{fo}. It matches @samp{f}, @samp{fo}, @samp{foo}, and so on. |
6552 | 234 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
235 The matcher processes a @samp{*} construct by matching, immediately, as |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
236 many repetitions as can be found. Then it continues with the rest of |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
237 the pattern. If that fails, backtracking occurs, discarding some of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
238 matches of the @samp{*}-modified construct in the hope that that will |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
239 make it possible to match the rest of the pattern. For example, in |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
240 matching @samp{ca*ar} against the string @samp{caaar}, the @samp{a*} |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
241 first tries to match all three @samp{a}s; but the rest of the pattern is |
6552 | 242 @samp{ar} and there is only @samp{r} left to match, so this try fails. |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
243 The next alternative is for @samp{a*} to match only two @samp{a}s. With |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
244 this choice, the rest of the regexp matches successfully.@refill |
6552 | 245 |
11651
f43818d3bbd8
Warn about nested repetition.
Richard M. Stallman <rms@gnu.org>
parents:
10038
diff
changeset
|
246 Nested repetition operators can be extremely slow if they specify |
12067 | 247 backtracking loops. For example, it could take hours for the regular |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
248 expression @samp{\(x+y*\)*a} to try to match the sequence |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
249 @samp{xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxz}, before it ultimately fails. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
250 The slowness is because Emacs must try each imaginable way of grouping |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
251 the 35 @samp{x}s before concluding that none of them can work. To make |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
252 sure your regular expressions run fast, check nested repetitions |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
253 carefully. |
11651
f43818d3bbd8
Warn about nested repetition.
Richard M. Stallman <rms@gnu.org>
parents:
10038
diff
changeset
|
254 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
255 @item @samp{+} |
6552 | 256 @cindex @samp{+} in regexp |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
257 is a postfix operator, similar to @samp{*} except that it must match |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
258 the preceding expression at least once. So, for example, @samp{ca+r} |
6552 | 259 matches the strings @samp{car} and @samp{caaaar} but not the string |
260 @samp{cr}, whereas @samp{ca*r} matches all three strings. | |
261 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
262 @item @samp{?} |
6552 | 263 @cindex @samp{?} in regexp |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
264 is a postfix operator, similar to @samp{*} except that it must match the |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
265 preceding expression either once or not at all. For example, |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
266 @samp{ca?r} matches @samp{car} or @samp{cr}; nothing else. |
6552 | 267 |
27095
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
268 @item @samp{*?}, @samp{+?}, @samp{??} |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
269 These are ``non-greedy'' variants of the operators @samp{*}, @samp{+} |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
270 and @samp{?}. Where those operators match the largest possible |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
271 substring (consistent with matching the entire containing expression), |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
272 the non-greedy variants match the smallest possible substring |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
273 (consistent with matching the entire containing expression). |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
274 |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
275 For example, the regular expression @samp{c[ad]*a} when applied to the |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
276 string @samp{cdaaada} matches the whole string; but the regular |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
277 expression @samp{c[ad]*?a}, applied to that same string, matches just |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
278 @samp{cda}. (The smallest possible match here for @samp{[ad]*?} that |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
279 permits the whole expression to match is @samp{d}.) |
7cc86d68ccf8
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
26783
diff
changeset
|
280 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
281 @item @samp{[ @dots{} ]} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
282 @cindex character alternative (in regexp) |
6552 | 283 @cindex @samp{[} in regexp |
284 @cindex @samp{]} in regexp | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
285 is a @dfn{character alternative}, which begins with @samp{[} and is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
286 terminated by @samp{]}. In the simplest case, the characters between |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
287 the two brackets are what this character alternative can match. |
6552 | 288 |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
289 Thus, @samp{[ad]} matches either one @samp{a} or one @samp{d}, and |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
290 @samp{[ad]*} matches any string composed of just @samp{a}s and @samp{d}s |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
291 (including the empty string), from which it follows that @samp{c[ad]*r} |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
292 matches @samp{cr}, @samp{car}, @samp{cdr}, @samp{caddaar}, etc. |
6552 | 293 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
294 You can also include character ranges in a character alternative, by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
295 writing the starting and ending characters with a @samp{-} between them. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
296 Thus, @samp{[a-z]} matches any lower-case @sc{ascii} letter. Ranges may be |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
297 intermixed freely with individual characters, as in @samp{[a-z$%.]}, |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
298 which matches any lower case @sc{ascii} letter or @samp{$}, @samp{%} or |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
299 period. |
6552 | 300 |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
301 Note that the usual regexp special characters are not special inside a |
24934 | 302 character alternative. A completely different set of characters is |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
303 special inside character alternatives: @samp{]}, @samp{-} and @samp{^}. |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
304 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
305 To include a @samp{]} in a character alternative, you must make it the |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
306 first character. For example, @samp{[]a]} matches @samp{]} or @samp{a}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
307 To include a @samp{-}, write @samp{-} as the first or last character of |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
308 the character alternative, or put it after a range. Thus, @samp{[]-]} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
309 matches both @samp{]} and @samp{-}. |
6552 | 310 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
311 To include @samp{^} in a character alternative, put it anywhere but at |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
312 the beginning. |
6552 | 313 |
37842
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
314 The beginning and end of a range of multibyte characters must be in |
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
315 the same character set (@pxref{Character Sets}). Thus, |
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
316 @code{"[\x8e0-\x97c]"} is invalid because character 0x8e0 (@samp{a} |
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
317 with grave accent) is in the Emacs character set for Latin-1 but the |
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
318 character 0x97c (@samp{u} with diaeresis) is in the Emacs character |
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
319 set for Latin-2. (We use Lisp string syntax to write that example, |
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
320 and a few others in the next few paragraphs, in order to include hex |
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
321 escape sequences in them.) |
32464 | 322 |
323 If a range starts with a unibyte character @var{c} and ends with a | |
324 multibyte character @var{c2}, the range is divided into two parts: one | |
325 is @samp{@var{c}..?\377}, the other is @samp{@var{c1}..@var{c2}}, where | |
326 @var{c1} is the first character of the charset to which @var{c2} | |
327 belongs. | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
328 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
329 You cannot always match all non-@sc{ascii} characters with the regular |
37842
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
330 expression @code{"[\200-\377]"}. This works when searching a unibyte |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
331 buffer or string (@pxref{Text Representations}), but not in a multibyte |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
332 buffer or string, because many non-@sc{ascii} characters have codes |
37842
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
333 above octal 0377. However, the regular expression @code{"[^\000-\177]"} |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
334 does match all non-@sc{ascii} characters (see below regarding @samp{^}), |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
335 in both multibyte and unibyte representations, because only the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
336 @sc{ascii} characters are excluded. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
337 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
338 Starting in Emacs 21, a character alternative can also specify named |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
339 character classes (@pxref{Char Classes}). This is a POSIX feature whose |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
340 syntax is @samp{[:@var{class}:]}. Using a character class is equivalent |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
341 to mentioning each of the characters in that class; but the latter is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
342 not feasible in practice, since some classes include thousands of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
343 different characters. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
344 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
345 @item @samp{[^ @dots{} ]} |
6552 | 346 @cindex @samp{^} in regexp |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
347 @samp{[^} begins a @dfn{complemented character alternative}, which matches any |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
348 character except the ones specified. Thus, @samp{[^a-z0-9A-Z]} matches |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
349 all characters @emph{except} letters and digits. |
6552 | 350 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
351 @samp{^} is not special in a character alternative unless it is the first |
6552 | 352 character. The character following the @samp{^} is treated as if it |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
353 were first (in other words, @samp{-} and @samp{]} are not special there). |
6552 | 354 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
355 A complemented character alternative can match a newline, unless newline is |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
356 mentioned as one of the characters not to match. This is in contrast to |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
357 the handling of regexps in programs such as @code{grep}. |
6552 | 358 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
359 @item @samp{^} |
6552 | 360 @cindex beginning of line in regexp |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
361 is a special character that matches the empty string, but only at the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
362 beginning of a line in the text being matched. Otherwise it fails to |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
363 match anything. Thus, @samp{^foo} matches a @samp{foo} that occurs at |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
364 the beginning of a line. |
6552 | 365 |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
366 When matching a string instead of a buffer, @samp{^} matches at the |
37842
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
367 beginning of the string or after a newline character. |
6552 | 368 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
369 For historical compatibility reasons, @samp{^} can be used only at the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
370 beginning of the regular expression, or after @samp{\(} or @samp{\|}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
371 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
372 @item @samp{$} |
6552 | 373 @cindex @samp{$} in regexp |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
374 @cindex end of line in regexp |
6552 | 375 is similar to @samp{^} but matches only at the end of a line. Thus, |
376 @samp{x+$} matches a string of one @samp{x} or more at the end of a line. | |
377 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
378 When matching a string instead of a buffer, @samp{$} matches at the end |
37842
2b1f94f72990
Use Lisp escape sequences only inside string syntax.
Richard M. Stallman <rms@gnu.org>
parents:
35796
diff
changeset
|
379 of the string or before a newline character. |
6552 | 380 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
381 For historical compatibility reasons, @samp{$} can be used only at the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
382 end of the regular expression, or before @samp{\)} or @samp{\|}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
383 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
384 @item @samp{\} |
6552 | 385 @cindex @samp{\} in regexp |
386 has two functions: it quotes the special characters (including | |
387 @samp{\}), and it introduces additional special constructs. | |
388 | |
389 Because @samp{\} quotes special characters, @samp{\$} is a regular | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
390 expression that matches only @samp{$}, and @samp{\[} is a regular |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
391 expression that matches only @samp{[}, and so on. |
6552 | 392 |
393 Note that @samp{\} also has special meaning in the read syntax of Lisp | |
394 strings (@pxref{String Type}), and must be quoted with @samp{\}. For | |
395 example, the regular expression that matches the @samp{\} character is | |
396 @samp{\\}. To write a Lisp string that contains the characters | |
397 @samp{\\}, Lisp syntax requires you to quote each @samp{\} with another | |
398 @samp{\}. Therefore, the read syntax for a regular expression matching | |
399 @samp{\} is @code{"\\\\"}.@refill | |
400 @end table | |
401 | |
7735
7db892210924
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7086
diff
changeset
|
402 @strong{Please note:} For historical compatibility, special characters |
6552 | 403 are treated as ordinary ones if they are in contexts where their special |
404 meanings make no sense. For example, @samp{*foo} treats @samp{*} as | |
405 ordinary since there is no preceding expression on which the @samp{*} | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
406 can act. It is poor practice to depend on this behavior; quote the |
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
407 special character anyway, regardless of where it appears.@refill |
6552 | 408 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
409 @node Char Classes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
410 @subsubsection Character Classes |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
411 @cindex character classes in regexp |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
412 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
413 Here is a table of the classes you can use in a character alternative, |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
414 in Emacs 21, and what they mean: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
415 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
416 @table @samp |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
417 @item [:ascii:] |
27373
a6d5729aef1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
418 This matches any @sc{ascii} (unibyte) character. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
419 @item [:alnum:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
420 This matches any letter or digit. (At present, for multibyte |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
421 characters, it matches anything that has word syntax.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
422 @item [:alpha:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
423 This matches any letter. (At present, for multibyte characters, it |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
424 matches anything that has word syntax.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
425 @item [:blank:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
426 This matches space and tab only. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
427 @item [:cntrl:] |
27373
a6d5729aef1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
428 This matches any @sc{ascii} control character. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
429 @item [:digit:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
430 This matches @samp{0} through @samp{9}. Thus, @samp{[-+[:digit:]]} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
431 matches any digit, as well as @samp{+} and @samp{-}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
432 @item [:graph:] |
27374
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27373
diff
changeset
|
433 This matches graphic characters---everything except @sc{ascii} control |
0f5edee5242b
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27373
diff
changeset
|
434 characters, space, and the delete character. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
435 @item [:lower:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
436 This matches any lower-case letter, as determined by |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
437 the current case table (@pxref{Case Tables}). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
438 @item [:nonascii:] |
27373
a6d5729aef1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
439 This matches any non-@sc{ascii} (multibyte) character. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
440 @item [:print:] |
27373
a6d5729aef1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
441 This matches printing characters---everything except @sc{ascii} control |
a6d5729aef1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27193
diff
changeset
|
442 characters and the delete character. |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
443 @item [:punct:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
444 This matches any punctuation character. (At present, for multibyte |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
445 characters, it matches anything that has non-word syntax.) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
446 @item [:space:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
447 This matches any character that has whitespace syntax |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
448 (@pxref{Syntax Class Table}). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
449 @item [:upper:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
450 This matches any upper-case letter, as determined by |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
451 the current case table (@pxref{Case Tables}). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
452 @item [:word:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
453 This matches any character that has word syntax (@pxref{Syntax Class |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
454 Table}). |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
455 @item [:xdigit:] |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
456 This matches the hexadecimal digits: @samp{0} through @samp{9}, @samp{a} |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
457 through @samp{f} and @samp{A} through @samp{F}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
458 @end table |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
459 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
460 @node Regexp Backslash |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
461 @subsubsection Backslash Constructs in Regular Expressions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
462 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
463 For the most part, @samp{\} followed by any character matches only |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
464 that character. However, there are several exceptions: certain |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
465 two-character sequences starting with @samp{\} that have special |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
466 meanings. (The character after the @samp{\} in such a sequence is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
467 always ordinary when used on its own.) Here is a table of the special |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
468 @samp{\} constructs. |
6552 | 469 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
470 @table @samp |
6552 | 471 @item \| |
472 @cindex @samp{|} in regexp | |
473 @cindex regexp alternative | |
474 specifies an alternative. | |
475 Two regular expressions @var{a} and @var{b} with @samp{\|} in | |
476 between form an expression that matches anything that either @var{a} or | |
477 @var{b} matches.@refill | |
478 | |
479 Thus, @samp{foo\|bar} matches either @samp{foo} or @samp{bar} | |
480 but no other string.@refill | |
481 | |
482 @samp{\|} applies to the largest possible surrounding expressions. Only a | |
483 surrounding @samp{\( @dots{} \)} grouping can limit the grouping power of | |
484 @samp{\|}.@refill | |
485 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
486 Full backtracking capability exists to handle multiple uses of |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
487 @samp{\|}, if you use the POSIX regular expression functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
488 (@pxref{POSIX Regexps}). |
6552 | 489 |
27780
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
490 @item \@{@var{m}\@} |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
491 is a postfix operator that repeats the previous pattern exactly @var{m} |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
492 times. Thus, @samp{x\@{5\@}} matches the string @samp{xxxxx} |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
493 and nothing else. @samp{c[ad]\@{3\@}r} matches string such as |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
494 @samp{caaar}, @samp{cdddr}, @samp{cadar}, and so on. |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
495 |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
496 @item \@{@var{m},@var{n}\@} |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
497 is more general postfix operator that specifies repetition with a |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
498 minimum of @var{m} repeats and a maximum of @var{n} repeats. If @var{m} |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
499 is omitted, the minimum is 0; if @var{n} is omitted, there is no |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
500 maximum. |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
501 |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
502 For example, @samp{c[ad]\@{1,2\@}r} matches the strings @samp{car}, |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
503 @samp{cdr}, @samp{caar}, @samp{cadr}, @samp{cdar}, and @samp{cddr}, and |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
504 nothing else.@* |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
505 @samp{\@{0,1\@}} or @samp{\@{,1\@}} is equivalent to @samp{?}. @* |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
506 @samp{\@{0,\@}} or @samp{\@{,\@}} is equivalent to @samp{*}. @* |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
507 @samp{\@{1,\@}} is equivalent to @samp{+}. |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
508 |
6552 | 509 @item \( @dots{} \) |
510 @cindex @samp{(} in regexp | |
511 @cindex @samp{)} in regexp | |
512 @cindex regexp grouping | |
513 is a grouping construct that serves three purposes: | |
514 | |
515 @enumerate | |
516 @item | |
16736
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12805
diff
changeset
|
517 To enclose a set of @samp{\|} alternatives for other operations. Thus, |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12805
diff
changeset
|
518 the regular expression @samp{\(foo\|bar\)x} matches either @samp{foox} |
981e116b4ac6
Minor cleanups for overfull hboxes.
Richard M. Stallman <rms@gnu.org>
parents:
12805
diff
changeset
|
519 or @samp{barx}. |
6552 | 520 |
521 @item | |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
522 To enclose a complicated expression for the postfix operators @samp{*}, |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
523 @samp{+} and @samp{?} to operate on. Thus, @samp{ba\(na\)*} matches |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
524 @samp{ba}, @samp{bana}, @samp{banana}, @samp{bananana}, etc., with any |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
525 number (zero or more) of @samp{na} strings. |
6552 | 526 |
527 @item | |
27780
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
528 To record a matched substring for future reference with |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
529 @samp{\@var{digit}} (see below). |
6552 | 530 @end enumerate |
531 | |
532 This last application is not a consequence of the idea of a | |
27780
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
533 parenthetical grouping; it is a separate feature that was assigned as a |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
534 second meaning to the same @samp{\( @dots{} \)} construct because, in |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
535 pratice, there was usually no conflict between the two meanings. But |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
536 occasionally there is a conflict, and that led to the introduction of |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
537 shy groups. |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
538 |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
539 @item \(?: @dots{} \) |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
540 is the @dfn{shy group} construct. A shy group serves the first two |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
541 purposes of an ordinary group (controlling the nesting of other |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
542 operators), but it does not get a number, so you cannot refer back to |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
543 its value with @samp{\@var{digit}}. |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
544 |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
545 Shy groups are particulary useful for mechanically-constructed regular |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
546 expressions because they can be added automatically without altering the |
72cae205b4f4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
27374
diff
changeset
|
547 numbering of any ordinary, non-shy groups. |
6552 | 548 |
549 @item \@var{digit} | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
550 matches the same text that matched the @var{digit}th occurrence of a |
6552 | 551 @samp{\( @dots{} \)} construct. |
552 | |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
553 In other words, after the end of a @samp{\( @dots{} \)} construct, the |
6552 | 554 matcher remembers the beginning and end of the text matched by that |
555 construct. Then, later on in the regular expression, you can use | |
556 @samp{\} followed by @var{digit} to match that same text, whatever it | |
557 may have been. | |
558 | |
559 The strings matching the first nine @samp{\( @dots{} \)} constructs | |
560 appearing in a regular expression are assigned numbers 1 through 9 in | |
561 the order that the open parentheses appear in the regular expression. | |
562 So you can use @samp{\1} through @samp{\9} to refer to the text matched | |
563 by the corresponding @samp{\( @dots{} \)} constructs. | |
564 | |
565 For example, @samp{\(.*\)\1} matches any newline-free string that is | |
566 composed of two identical halves. The @samp{\(.*\)} matches the first | |
567 half, which may be anything, but the @samp{\1} that follows must match | |
568 the same exact text. | |
569 | |
570 @item \w | |
571 @cindex @samp{\w} in regexp | |
572 matches any word-constituent character. The editor syntax table | |
573 determines which characters these are. @xref{Syntax Tables}. | |
574 | |
575 @item \W | |
576 @cindex @samp{\W} in regexp | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
577 matches any character that is not a word constituent. |
6552 | 578 |
579 @item \s@var{code} | |
580 @cindex @samp{\s} in regexp | |
581 matches any character whose syntax is @var{code}. Here @var{code} is a | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
582 character that represents a syntax code: thus, @samp{w} for word |
6552 | 583 constituent, @samp{-} for whitespace, @samp{(} for open parenthesis, |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
584 etc. To represent whitespace syntax, use either @samp{-} or a space |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
585 character. @xref{Syntax Class Table}, for a list of syntax codes and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
586 the characters that stand for them. |
6552 | 587 |
588 @item \S@var{code} | |
589 @cindex @samp{\S} in regexp | |
590 matches any character whose syntax is not @var{code}. | |
35796 | 591 |
592 @item \c@var{c} | |
593 matches any character whose category is @var{c}. Here @var{c} is a | |
594 character that represents a category: thus, @samp{c} for Chinese | |
595 characters or @samp{g} for Greek characters in the standard category | |
596 table. | |
597 | |
598 @item \C@var{c} | |
599 matches any character whose category is not @var{c}. | |
6552 | 600 @end table |
601 | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
602 The following regular expression constructs match the empty string---that is, |
6552 | 603 they don't use up any characters---but whether they match depends on the |
604 context. | |
605 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
606 @table @samp |
6552 | 607 @item \` |
608 @cindex @samp{\`} in regexp | |
609 matches the empty string, but only at the beginning | |
610 of the buffer or string being matched against. | |
611 | |
612 @item \' | |
613 @cindex @samp{\'} in regexp | |
614 matches the empty string, but only at the end of | |
615 the buffer or string being matched against. | |
616 | |
617 @item \= | |
618 @cindex @samp{\=} in regexp | |
619 matches the empty string, but only at point. | |
620 (This construct is not defined when matching against a string.) | |
621 | |
622 @item \b | |
623 @cindex @samp{\b} in regexp | |
624 matches the empty string, but only at the beginning or | |
625 end of a word. Thus, @samp{\bfoo\b} matches any occurrence of | |
626 @samp{foo} as a separate word. @samp{\bballs?\b} matches | |
627 @samp{ball} or @samp{balls} as a separate word.@refill | |
628 | |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
629 @samp{\b} matches at the beginning or end of the buffer |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
630 regardless of what text appears next to it. |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
631 |
6552 | 632 @item \B |
633 @cindex @samp{\B} in regexp | |
634 matches the empty string, but @emph{not} at the beginning or | |
635 end of a word. | |
636 | |
637 @item \< | |
638 @cindex @samp{\<} in regexp | |
639 matches the empty string, but only at the beginning of a word. | |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
640 @samp{\<} matches at the beginning of the buffer only if a |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
641 word-constituent character follows. |
6552 | 642 |
643 @item \> | |
644 @cindex @samp{\>} in regexp | |
17884
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
645 matches the empty string, but only at the end of a word. @samp{\>} |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
646 matches at the end of the buffer only if the contents end with a |
aa0b21b54684
Update regexp syntax from Emacs manual.
Richard M. Stallman <rms@gnu.org>
parents:
16736
diff
changeset
|
647 word-constituent character. |
6552 | 648 @end table |
649 | |
650 @kindex invalid-regexp | |
651 Not every string is a valid regular expression. For example, a string | |
652 with unbalanced square brackets is invalid (with a few exceptions, such | |
8427
bc548090f760
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
7735
diff
changeset
|
653 as @samp{[]]}), and so is a string that ends with a single @samp{\}. If |
6552 | 654 an invalid regular expression is passed to any of the search functions, |
655 an @code{invalid-regexp} error is signaled. | |
656 | |
657 @node Regexp Example | |
658 @comment node-name, next, previous, up | |
659 @subsection Complex Regexp Example | |
660 | |
661 Here is a complicated regexp, used by Emacs to recognize the end of a | |
662 sentence together with any whitespace that follows. It is the value of | |
663 the variable @code{sentence-end}. | |
664 | |
665 First, we show the regexp as a string in Lisp syntax to distinguish | |
666 spaces from tab characters. The string constant begins and ends with a | |
667 double-quote. @samp{\"} stands for a double-quote as part of the | |
668 string, @samp{\\} for a backslash as part of the string, @samp{\t} for a | |
669 tab and @samp{\n} for a newline. | |
670 | |
671 @example | |
672 "[.?!][]\"')@}]*\\($\\| $\\|\t\\| \\)[ \t\n]*" | |
673 @end example | |
674 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
675 @noindent |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
676 In contrast, if you evaluate the variable @code{sentence-end}, you |
6552 | 677 will see the following: |
678 | |
679 @example | |
680 @group | |
681 sentence-end | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
682 @result{} "[.?!][]\"')@}]*\\($\\| $\\| \\| \\)[ |
6552 | 683 ]*" |
684 @end group | |
685 @end example | |
686 | |
687 @noindent | |
688 In this output, tab and newline appear as themselves. | |
689 | |
690 This regular expression contains four parts in succession and can be | |
691 deciphered as follows: | |
692 | |
693 @table @code | |
694 @item [.?!] | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
695 The first part of the pattern is a character alternative that matches |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
696 any one of three characters: period, question mark, and exclamation |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
697 mark. The match must begin with one of these three characters. |
6552 | 698 |
699 @item []\"')@}]* | |
700 The second part of the pattern matches any closing braces and quotation | |
701 marks, zero or more of them, that may follow the period, question mark | |
702 or exclamation mark. The @code{\"} is Lisp syntax for a double-quote in | |
703 a string. The @samp{*} at the end indicates that the immediately | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
704 preceding regular expression (a character alternative, in this case) may be |
6552 | 705 repeated zero or more times. |
706 | |
8469 | 707 @item \\($\\|@ $\\|\t\\|@ @ \\) |
6552 | 708 The third part of the pattern matches the whitespace that follows the |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
709 end of a sentence: the end of a line (optionally with a space), or a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
710 tab, or two spaces. The double backslashes mark the parentheses and |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
711 vertical bars as regular expression syntax; the parentheses delimit a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
712 group and the vertical bars separate alternatives. The dollar sign is |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
713 used to match the end of a line. |
6552 | 714 |
715 @item [ \t\n]* | |
716 Finally, the last part of the pattern matches any additional whitespace | |
717 beyond the minimum needed to end a sentence. | |
718 @end table | |
719 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
720 @node Regexp Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
721 @subsection Regular Expression Functions |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
722 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
723 These functions operate on regular expressions. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
724 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
725 @defun regexp-quote string |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
726 This function returns a regular expression whose only exact match is |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
727 @var{string}. Using this regular expression in @code{looking-at} will |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
728 succeed only if the next characters in the buffer are @var{string}; |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
729 using it in a search function will succeed if the text being searched |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
730 contains @var{string}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
731 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
732 This allows you to request an exact string match or search when calling |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
733 a function that wants a regular expression. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
734 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
735 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
736 @group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
737 (regexp-quote "^The cat$") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
738 @result{} "\\^The cat\\$" |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
739 @end group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
740 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
741 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
742 One use of @code{regexp-quote} is to combine an exact string match with |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
743 context described as a regular expression. For example, this searches |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
744 for the string that is the value of @var{string}, surrounded by |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
745 whitespace: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
746 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
747 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
748 @group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
749 (re-search-forward |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
750 (concat "\\s-" (regexp-quote string) "\\s-")) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
751 @end group |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
752 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
753 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
754 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
755 @defun regexp-opt strings &optional paren |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
756 This function returns an efficient regular expression that will match |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
757 any of the strings @var{strings}. This is useful when you need to make |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
758 matching or searching as fast as possible---for example, for Font Lock |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
759 mode. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
760 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
761 If the optional argument @var{paren} is non-@code{nil}, then the |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
762 returned regular expression is always enclosed by at least one |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
763 parentheses-grouping construct. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
764 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
765 This simplified definition of @code{regexp-opt} produces a |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
766 regular expression which is equivalent to the actual value |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
767 (but not as efficient): |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
768 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
769 @example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
770 (defun regexp-opt (strings paren) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
771 (let ((open-paren (if paren "\\(" "")) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
772 (close-paren (if paren "\\)" ""))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
773 (concat open-paren |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
774 (mapconcat 'regexp-quote strings "\\|") |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
775 close-paren))) |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
776 @end example |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
777 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
778 |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
779 @defun regexp-opt-depth regexp |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
780 This function returns the total number of grouping constructs |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
781 (parenthesized expressions) in @var{regexp}. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
782 @end defun |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
783 |
6552 | 784 @node Regexp Search |
785 @section Regular Expression Searching | |
786 @cindex regular expression searching | |
787 @cindex regexp searching | |
788 @cindex searching for regexp | |
789 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
790 In GNU Emacs, you can search for the next match for a regular |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
791 expression either incrementally or not. For incremental search |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
792 commands, see @ref{Regexp Search, , Regular Expression Search, emacs, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
793 The GNU Emacs Manual}. Here we describe only the search functions |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
794 useful in programs. The principal one is @code{re-search-forward}. |
6552 | 795 |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
796 These search functions convert the regular expression to multibyte if |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
797 the buffer is multibyte; they convert the regular expression to unibyte |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
798 if the buffer is unibyte. @xref{Text Representations}. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
799 |
6552 | 800 @deffn Command re-search-forward regexp &optional limit noerror repeat |
801 This function searches forward in the current buffer for a string of | |
802 text that is matched by the regular expression @var{regexp}. The | |
803 function skips over any amount of text that is not matched by | |
804 @var{regexp}, and leaves point at the end of the first match found. | |
805 It returns the new value of point. | |
806 | |
807 If @var{limit} is non-@code{nil} (it must be a position in the current | |
808 buffer), then it is the upper bound to the search. No match extending | |
809 after that position is accepted. | |
810 | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
811 If @var{repeat} is supplied (it must be a positive number), then the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
812 search is repeated that many times (each time starting at the end of the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
813 previous time's match). If all these successive searches succeed, the |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
814 function succeeds, moving point and returning its new value. Otherwise |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
815 the function fails. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
816 |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
817 What happens when the function fails depends on the value of |
6552 | 818 @var{noerror}. If @var{noerror} is @code{nil}, a @code{search-failed} |
819 error is signaled. If @var{noerror} is @code{t}, | |
820 @code{re-search-forward} does nothing and returns @code{nil}. If | |
821 @var{noerror} is neither @code{nil} nor @code{t}, then | |
822 @code{re-search-forward} moves point to @var{limit} (or the end of the | |
823 buffer) and returns @code{nil}. | |
824 | |
825 In the following example, point is initially before the @samp{T}. | |
826 Evaluating the search call moves point to the end of that line (between | |
827 the @samp{t} of @samp{hat} and the newline). | |
828 | |
829 @example | |
830 @group | |
831 ---------- Buffer: foo ---------- | |
832 I read "@point{}The cat in the hat | |
833 comes back" twice. | |
834 ---------- Buffer: foo ---------- | |
835 @end group | |
836 | |
837 @group | |
838 (re-search-forward "[a-z]+" nil t 5) | |
839 @result{} 27 | |
840 | |
841 ---------- Buffer: foo ---------- | |
842 I read "The cat in the hat@point{} | |
843 comes back" twice. | |
844 ---------- Buffer: foo ---------- | |
845 @end group | |
846 @end example | |
847 @end deffn | |
848 | |
849 @deffn Command re-search-backward regexp &optional limit noerror repeat | |
850 This function searches backward in the current buffer for a string of | |
851 text that is matched by the regular expression @var{regexp}, leaving | |
852 point at the beginning of the first text found. | |
853 | |
8469 | 854 This function is analogous to @code{re-search-forward}, but they are not |
855 simple mirror images. @code{re-search-forward} finds the match whose | |
856 beginning is as close as possible to the starting point. If | |
857 @code{re-search-backward} were a perfect mirror image, it would find the | |
858 match whose end is as close as possible. However, in fact it finds the | |
25089 | 859 match whose beginning is as close as possible. The reason for this is that |
8469 | 860 matching a regular expression at a given spot always works from |
861 beginning to end, and starts at a specified beginning position. | |
6552 | 862 |
863 A true mirror-image of @code{re-search-forward} would require a special | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
864 feature for matching regular expressions from end to beginning. It's |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
865 not worth the trouble of implementing that. |
6552 | 866 @end deffn |
867 | |
868 @defun string-match regexp string &optional start | |
869 This function returns the index of the start of the first match for | |
870 the regular expression @var{regexp} in @var{string}, or @code{nil} if | |
871 there is no match. If @var{start} is non-@code{nil}, the search starts | |
872 at that index in @var{string}. | |
873 | |
874 For example, | |
875 | |
876 @example | |
877 @group | |
878 (string-match | |
879 "quick" "The quick brown fox jumped quickly.") | |
880 @result{} 4 | |
881 @end group | |
882 @group | |
883 (string-match | |
884 "quick" "The quick brown fox jumped quickly." 8) | |
885 @result{} 27 | |
886 @end group | |
887 @end example | |
888 | |
889 @noindent | |
890 The index of the first character of the | |
891 string is 0, the index of the second character is 1, and so on. | |
892 | |
893 After this function returns, the index of the first character beyond | |
894 the match is available as @code{(match-end 0)}. @xref{Match Data}. | |
895 | |
896 @example | |
897 @group | |
898 (string-match | |
899 "quick" "The quick brown fox jumped quickly." 8) | |
900 @result{} 27 | |
901 @end group | |
902 | |
903 @group | |
904 (match-end 0) | |
905 @result{} 32 | |
906 @end group | |
907 @end example | |
908 @end defun | |
909 | |
910 @defun looking-at regexp | |
911 This function determines whether the text in the current buffer directly | |
912 following point matches the regular expression @var{regexp}. ``Directly | |
913 following'' means precisely that: the search is ``anchored'' and it can | |
914 succeed only starting with the first character following point. The | |
915 result is @code{t} if so, @code{nil} otherwise. | |
916 | |
917 This function does not move point, but it updates the match data, which | |
918 you can access using @code{match-beginning} and @code{match-end}. | |
919 @xref{Match Data}. | |
920 | |
921 In this example, point is located directly before the @samp{T}. If it | |
922 were anywhere else, the result would be @code{nil}. | |
923 | |
924 @example | |
925 @group | |
926 ---------- Buffer: foo ---------- | |
927 I read "@point{}The cat in the hat | |
928 comes back" twice. | |
929 ---------- Buffer: foo ---------- | |
930 | |
931 (looking-at "The cat in the hat$") | |
932 @result{} t | |
933 @end group | |
934 @end example | |
935 @end defun | |
936 | |
12067 | 937 @node POSIX Regexps |
938 @section POSIX Regular Expression Searching | |
939 | |
940 The usual regular expression functions do backtracking when necessary | |
941 to handle the @samp{\|} and repetition constructs, but they continue | |
942 this only until they find @emph{some} match. Then they succeed and | |
943 report the first match found. | |
944 | |
945 This section describes alternative search functions which perform the | |
946 full backtracking specified by the POSIX standard for regular expression | |
947 matching. They continue backtracking until they have tried all | |
948 possibilities and found all matches, so they can report the longest | |
949 match, as required by POSIX. This is much slower, so use these | |
950 functions only when you really need the longest match. | |
951 | |
952 @defun posix-search-forward regexp &optional limit noerror repeat | |
953 This is like @code{re-search-forward} except that it performs the full | |
954 backtracking specified by the POSIX standard for regular expression | |
955 matching. | |
956 @end defun | |
957 | |
958 @defun posix-search-backward regexp &optional limit noerror repeat | |
959 This is like @code{re-search-backward} except that it performs the full | |
960 backtracking specified by the POSIX standard for regular expression | |
961 matching. | |
962 @end defun | |
963 | |
964 @defun posix-looking-at regexp | |
965 This is like @code{looking-at} except that it performs the full | |
966 backtracking specified by the POSIX standard for regular expression | |
967 matching. | |
968 @end defun | |
969 | |
970 @defun posix-string-match regexp string &optional start | |
971 This is like @code{string-match} except that it performs the full | |
972 backtracking specified by the POSIX standard for regular expression | |
973 matching. | |
974 @end defun | |
975 | |
6552 | 976 @ignore |
977 @deffn Command delete-matching-lines regexp | |
978 This function is identical to @code{delete-non-matching-lines}, save | |
979 that it deletes what @code{delete-non-matching-lines} keeps. | |
980 | |
981 In the example below, point is located on the first line of text. | |
982 | |
983 @example | |
984 @group | |
985 ---------- Buffer: foo ---------- | |
986 We hold these truths | |
987 to be self-evident, | |
988 that all men are created | |
989 equal, and that they are | |
990 ---------- Buffer: foo ---------- | |
991 @end group | |
992 | |
993 @group | |
994 (delete-matching-lines "the") | |
995 @result{} nil | |
996 | |
997 ---------- Buffer: foo ---------- | |
998 to be self-evident, | |
999 that all men are created | |
1000 ---------- Buffer: foo ---------- | |
1001 @end group | |
1002 @end example | |
1003 @end deffn | |
1004 | |
1005 @deffn Command flush-lines regexp | |
1006 This function is the same as @code{delete-matching-lines}. | |
1007 @end deffn | |
1008 | |
1009 @defun delete-non-matching-lines regexp | |
1010 This function deletes all lines following point which don't | |
1011 contain a match for the regular expression @var{regexp}. | |
1012 @end defun | |
1013 | |
1014 @deffn Command keep-lines regexp | |
1015 This function is the same as @code{delete-non-matching-lines}. | |
1016 @end deffn | |
1017 | |
1018 @deffn Command how-many regexp | |
1019 This function counts the number of matches for @var{regexp} there are in | |
1020 the current buffer following point. It prints this number in | |
1021 the echo area, returning the string printed. | |
1022 @end deffn | |
1023 | |
1024 @deffn Command count-matches regexp | |
1025 This function is a synonym of @code{how-many}. | |
1026 @end deffn | |
1027 | |
26288 | 1028 @deffn Command list-matching-lines regexp &optional nlines |
6552 | 1029 This function is a synonym of @code{occur}. |
1030 Show all lines following point containing a match for @var{regexp}. | |
1031 Display each line with @var{nlines} lines before and after, | |
1032 or @code{-}@var{nlines} before if @var{nlines} is negative. | |
1033 @var{nlines} defaults to @code{list-matching-lines-default-context-lines}. | |
1034 Interactively it is the prefix arg. | |
1035 | |
1036 The lines are shown in a buffer named @samp{*Occur*}. | |
1037 It serves as a menu to find any of the occurrences in this buffer. | |
24934 | 1038 @kbd{C-h m} (@code{describe-mode}) in that buffer gives help. |
6552 | 1039 @end deffn |
1040 | |
1041 @defopt list-matching-lines-default-context-lines | |
1042 Default value is 0. | |
1043 Default number of context lines to include around a @code{list-matching-lines} | |
1044 match. A negative number means to include that many lines before the match. | |
1045 A positive number means to include that many lines both before and after. | |
1046 @end defopt | |
1047 @end ignore | |
1048 | |
1049 @node Search and Replace | |
1050 @section Search and Replace | |
1051 @cindex replacement | |
1052 | |
1053 @defun perform-replace from-string replacements query-flag regexp-flag delimited-flag &optional repeat-count map | |
1054 This function is the guts of @code{query-replace} and related commands. | |
1055 It searches for occurrences of @var{from-string} and replaces some or | |
1056 all of them. If @var{query-flag} is @code{nil}, it replaces all | |
1057 occurrences; otherwise, it asks the user what to do about each one. | |
1058 | |
1059 If @var{regexp-flag} is non-@code{nil}, then @var{from-string} is | |
1060 considered a regular expression; otherwise, it must match literally. If | |
1061 @var{delimited-flag} is non-@code{nil}, then only replacements | |
1062 surrounded by word boundaries are considered. | |
1063 | |
1064 The argument @var{replacements} specifies what to replace occurrences | |
1065 with. If it is a string, that string is used. It can also be a list of | |
1066 strings, to be used in cyclic order. | |
1067 | |
26783 | 1068 If @var{replacements} is a cons cell, @code{(@var{function} |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1069 . @var{data})}, this means to call @var{function} after each match to |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1070 get the replacement text. This function is called with two arguments: |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1071 @var{data}, and the number of replacements already made. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1072 |
12282
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12125
diff
changeset
|
1073 If @var{repeat-count} is non-@code{nil}, it should be an integer. Then |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12125
diff
changeset
|
1074 it specifies how many times to use each of the strings in the |
586e3ea81792
updates for version 19.29 made by melissa; also needed to check out files
Melissa Weisshaus <melissa@gnu.org>
parents:
12125
diff
changeset
|
1075 @var{replacements} list before advancing cyclicly to the next one. |
6552 | 1076 |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1077 If @var{from-string} contains upper-case letters, then |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1078 @code{perform-replace} binds @code{case-fold-search} to @code{nil}, and |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1079 it uses the @code{replacements} without altering the case of them. |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1080 |
6552 | 1081 Normally, the keymap @code{query-replace-map} defines the possible user |
8469 | 1082 responses for queries. The argument @var{map}, if non-@code{nil}, is a |
1083 keymap to use instead of @code{query-replace-map}. | |
6552 | 1084 @end defun |
1085 | |
1086 @defvar query-replace-map | |
1087 This variable holds a special keymap that defines the valid user | |
1088 responses for @code{query-replace} and related functions, as well as | |
1089 @code{y-or-n-p} and @code{map-y-or-n-p}. It is unusual in two ways: | |
1090 | |
1091 @itemize @bullet | |
1092 @item | |
1093 The ``key bindings'' are not commands, just symbols that are meaningful | |
1094 to the functions that use this map. | |
1095 | |
1096 @item | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1097 Prefix keys are not supported; each key binding must be for a |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1098 single-event key sequence. This is because the functions don't use |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1099 @code{read-key-sequence} to get the input; instead, they read a single |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1100 event and look it up ``by hand.'' |
6552 | 1101 @end itemize |
1102 @end defvar | |
1103 | |
1104 Here are the meaningful ``bindings'' for @code{query-replace-map}. | |
1105 Several of them are meaningful only for @code{query-replace} and | |
1106 friends. | |
1107 | |
1108 @table @code | |
1109 @item act | |
1110 Do take the action being considered---in other words, ``yes.'' | |
1111 | |
1112 @item skip | |
1113 Do not take action for this question---in other words, ``no.'' | |
1114 | |
1115 @item exit | |
8469 | 1116 Answer this question ``no,'' and give up on the entire series of |
1117 questions, assuming that the answers will be ``no.'' | |
6552 | 1118 |
1119 @item act-and-exit | |
8469 | 1120 Answer this question ``yes,'' and give up on the entire series of |
1121 questions, assuming that subsequent answers will be ``no.'' | |
6552 | 1122 |
1123 @item act-and-show | |
1124 Answer this question ``yes,'' but show the results---don't advance yet | |
1125 to the next question. | |
1126 | |
1127 @item automatic | |
1128 Answer this question and all subsequent questions in the series with | |
1129 ``yes,'' without further user interaction. | |
1130 | |
1131 @item backup | |
1132 Move back to the previous place that a question was asked about. | |
1133 | |
1134 @item edit | |
1135 Enter a recursive edit to deal with this question---instead of any | |
1136 other action that would normally be taken. | |
1137 | |
1138 @item delete-and-edit | |
1139 Delete the text being considered, then enter a recursive edit to replace | |
1140 it. | |
1141 | |
1142 @item recenter | |
1143 Redisplay and center the window, then ask the same question again. | |
1144 | |
1145 @item quit | |
1146 Perform a quit right away. Only @code{y-or-n-p} and related functions | |
1147 use this answer. | |
1148 | |
1149 @item help | |
1150 Display some help, then ask again. | |
1151 @end table | |
1152 | |
1153 @node Match Data | |
1154 @section The Match Data | |
1155 @cindex match data | |
1156 | |
25089 | 1157 Emacs keeps track of the start and end positions of the segments of |
6552 | 1158 text found during a regular expression search. This means, for example, |
1159 that you can search for a complex pattern, such as a date in an Rmail | |
1160 message, and then extract parts of the match under control of the | |
1161 pattern. | |
1162 | |
1163 Because the match data normally describe the most recent search only, | |
1164 you must be careful not to do another search inadvertently between the | |
1165 search you wish to refer back to and the use of the match data. If you | |
1166 can't avoid another intervening search, you must save and restore the | |
1167 match data around it, to prevent it from being overwritten. | |
1168 | |
1169 @menu | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1170 * Replacing Match:: Replacing a substring that was matched. |
6552 | 1171 * Simple Match Data:: Accessing single items of match data, |
1172 such as where a particular subexpression started. | |
1173 * Entire Match Data:: Accessing the entire match data at once, as a list. | |
1174 * Saving Match Data:: Saving and restoring the match data. | |
1175 @end menu | |
1176 | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1177 @node Replacing Match |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1178 @subsection Replacing the Text that Matched |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1179 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1180 This function replaces the text matched by the last search with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1181 @var{replacement}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1182 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1183 @cindex case in replacements |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1184 @defun replace-match replacement &optional fixedcase literal string subexp |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1185 This function replaces the text in the buffer (or in @var{string}) that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1186 was matched by the last search. It replaces that text with |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1187 @var{replacement}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1188 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1189 If you did the last search in a buffer, you should specify @code{nil} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1190 for @var{string}. Then @code{replace-match} does the replacement by |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1191 editing the buffer; it leaves point at the end of the replacement text, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1192 and returns @code{t}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1193 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1194 If you did the search in a string, pass the same string as @var{string}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1195 Then @code{replace-match} does the replacement by constructing and |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1196 returning a new string. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1197 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1198 If @var{fixedcase} is non-@code{nil}, then the case of the replacement |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1199 text is not changed; otherwise, the replacement text is converted to a |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1200 different case depending upon the capitalization of the text to be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1201 replaced. If the original text is all upper case, the replacement text |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1202 is converted to upper case. If the first word of the original text is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1203 capitalized, then the first word of the replacement text is capitalized. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1204 If the original text contains just one word, and that word is a capital |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1205 letter, @code{replace-match} considers this a capitalized first word |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1206 rather than all upper case. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1207 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1208 If @var{literal} is non-@code{nil}, then @var{replacement} is inserted |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1209 exactly as it is, the only alterations being case changes as needed. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1210 If it is @code{nil} (the default), then the character @samp{\} is treated |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1211 specially. If a @samp{\} appears in @var{replacement}, then it must be |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1212 part of one of the following sequences: |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1213 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1214 @table @asis |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1215 @item @samp{\&} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1216 @cindex @samp{&} in replacement |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1217 @samp{\&} stands for the entire text being replaced. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1218 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1219 @item @samp{\@var{n}} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1220 @cindex @samp{\@var{n}} in replacement |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1221 @samp{\@var{n}}, where @var{n} is a digit, stands for the text that |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1222 matched the @var{n}th subexpression in the original regexp. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1223 Subexpressions are those expressions grouped inside @samp{\(@dots{}\)}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1224 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1225 @item @samp{\\} |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1226 @cindex @samp{\} in replacement |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1227 @samp{\\} stands for a single @samp{\} in the replacement text. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1228 @end table |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1229 |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1230 If @var{subexp} is non-@code{nil}, that says to replace just |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1231 subexpression number @var{subexp} of the regexp that was matched, not |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1232 the entire match. For example, after matching @samp{foo \(ba*r\)}, |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1233 calling @code{replace-match} with 1 as @var{subexp} means to replace |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1234 just the text that matched @samp{\(ba*r\)}. |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1235 @end defun |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1236 |
6552 | 1237 @node Simple Match Data |
1238 @subsection Simple Match Data Access | |
1239 | |
12067 | 1240 This section explains how to use the match data to find out what was |
1241 matched by the last search or match operation. | |
1242 | |
1243 You can ask about the entire matching text, or about a particular | |
1244 parenthetical subexpression of a regular expression. The @var{count} | |
1245 argument in the functions below specifies which. If @var{count} is | |
1246 zero, you are asking about the entire match. If @var{count} is | |
1247 positive, it specifies which subexpression you want. | |
1248 | |
1249 Recall that the subexpressions of a regular expression are those | |
1250 expressions grouped with escaped parentheses, @samp{\(@dots{}\)}. The | |
1251 @var{count}th subexpression is found by counting occurrences of | |
1252 @samp{\(} from the beginning of the whole regular expression. The first | |
1253 subexpression is numbered 1, the second 2, and so on. Only regular | |
1254 expressions can have subexpressions---after a simple string search, the | |
1255 only information available is about the entire match. | |
1256 | |
22138
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1257 A search which fails may or may not alter the match data. In the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1258 past, a failing search did not do this, but we may change it in the |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1259 future. |
d4ac295a98b3
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21682
diff
changeset
|
1260 |
12067 | 1261 @defun match-string count &optional in-string |
1262 This function returns, as a string, the text matched in the last search | |
1263 or match operation. It returns the entire text if @var{count} is zero, | |
1264 or just the portion corresponding to the @var{count}th parenthetical | |
1265 subexpression, if @var{count} is positive. If @var{count} is out of | |
12098 | 1266 range, or if that subexpression didn't match anything, the value is |
1267 @code{nil}. | |
12067 | 1268 |
1269 If the last such operation was done against a string with | |
1270 @code{string-match}, then you should pass the same string as the | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1271 argument @var{in-string}. After a buffer search or match, |
12067 | 1272 you should omit @var{in-string} or pass @code{nil} for it; but you |
1273 should make sure that the current buffer when you call | |
1274 @code{match-string} is the one in which you did the searching or | |
1275 matching. | |
1276 @end defun | |
6552 | 1277 |
26288 | 1278 @defun match-string-no-properties count &optional in-string |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1279 This function is like @code{match-string} except that the result |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1280 has no text properties. |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1281 @end defun |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1282 |
6552 | 1283 @defun match-beginning count |
1284 This function returns the position of the start of text matched by the | |
1285 last regular expression searched for, or a subexpression of it. | |
1286 | |
8469 | 1287 If @var{count} is zero, then the value is the position of the start of |
12125
995be67f3fd1
updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents:
12098
diff
changeset
|
1288 the entire match. Otherwise, @var{count} specifies a subexpression in |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1289 the regular expression, and the value of the function is the starting |
12067 | 1290 position of the match for that subexpression. |
6552 | 1291 |
12067 | 1292 The value is @code{nil} for a subexpression inside a @samp{\|} |
1293 alternative that wasn't used in the match. | |
6552 | 1294 @end defun |
1295 | |
1296 @defun match-end count | |
12067 | 1297 This function is like @code{match-beginning} except that it returns the |
1298 position of the end of the match, rather than the position of the | |
1299 beginning. | |
6552 | 1300 @end defun |
1301 | |
1302 Here is an example of using the match data, with a comment showing the | |
1303 positions within the text: | |
1304 | |
1305 @example | |
1306 @group | |
1307 (string-match "\\(qu\\)\\(ick\\)" | |
1308 "The quick fox jumped quickly.") | |
1309 ;0123456789 | |
1310 @result{} 4 | |
1311 @end group | |
1312 | |
1313 @group | |
12067 | 1314 (match-string 0 "The quick fox jumped quickly.") |
1315 @result{} "quick" | |
1316 (match-string 1 "The quick fox jumped quickly.") | |
1317 @result{} "qu" | |
1318 (match-string 2 "The quick fox jumped quickly.") | |
1319 @result{} "ick" | |
1320 @end group | |
1321 | |
1322 @group | |
6552 | 1323 (match-beginning 1) ; @r{The beginning of the match} |
1324 @result{} 4 ; @r{with @samp{qu} is at index 4.} | |
1325 @end group | |
1326 | |
1327 @group | |
1328 (match-beginning 2) ; @r{The beginning of the match} | |
1329 @result{} 6 ; @r{with @samp{ick} is at index 6.} | |
1330 @end group | |
1331 | |
1332 @group | |
1333 (match-end 1) ; @r{The end of the match} | |
1334 @result{} 6 ; @r{with @samp{qu} is at index 6.} | |
1335 | |
1336 (match-end 2) ; @r{The end of the match} | |
1337 @result{} 9 ; @r{with @samp{ick} is at index 9.} | |
1338 @end group | |
1339 @end example | |
1340 | |
1341 Here is another example. Point is initially located at the beginning | |
1342 of the line. Searching moves point to between the space and the word | |
1343 @samp{in}. The beginning of the entire match is at the 9th character of | |
1344 the buffer (@samp{T}), and the beginning of the match for the first | |
1345 subexpression is at the 13th character (@samp{c}). | |
1346 | |
1347 @example | |
1348 @group | |
1349 (list | |
1350 (re-search-forward "The \\(cat \\)") | |
1351 (match-beginning 0) | |
1352 (match-beginning 1)) | |
8469 | 1353 @result{} (9 9 13) |
6552 | 1354 @end group |
1355 | |
1356 @group | |
1357 ---------- Buffer: foo ---------- | |
1358 I read "The cat @point{}in the hat comes back" twice. | |
1359 ^ ^ | |
1360 9 13 | |
1361 ---------- Buffer: foo ---------- | |
1362 @end group | |
1363 @end example | |
1364 | |
1365 @noindent | |
1366 (In this case, the index returned is a buffer position; the first | |
1367 character of the buffer counts as 1.) | |
1368 | |
1369 @node Entire Match Data | |
1370 @subsection Accessing the Entire Match Data | |
1371 | |
1372 The functions @code{match-data} and @code{set-match-data} read or | |
1373 write the entire match data, all at once. | |
1374 | |
1375 @defun match-data | |
1376 This function returns a newly constructed list containing all the | |
1377 information on what text the last search matched. Element zero is the | |
1378 position of the beginning of the match for the whole expression; element | |
1379 one is the position of the end of the match for the expression. The | |
1380 next two elements are the positions of the beginning and end of the | |
1381 match for the first subexpression, and so on. In general, element | |
27193 | 1382 @ifnottex |
6552 | 1383 number 2@var{n} |
27193 | 1384 @end ifnottex |
6552 | 1385 @tex |
1386 number {\mathsurround=0pt $2n$} | |
1387 @end tex | |
1388 corresponds to @code{(match-beginning @var{n})}; and | |
1389 element | |
27193 | 1390 @ifnottex |
6552 | 1391 number 2@var{n} + 1 |
27193 | 1392 @end ifnottex |
6552 | 1393 @tex |
1394 number {\mathsurround=0pt $2n+1$} | |
1395 @end tex | |
1396 corresponds to @code{(match-end @var{n})}. | |
1397 | |
1398 All the elements are markers or @code{nil} if matching was done on a | |
1399 buffer, and all are integers or @code{nil} if matching was done on a | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1400 string with @code{string-match}. |
6552 | 1401 |
1402 As always, there must be no possibility of intervening searches between | |
1403 the call to a search function and the call to @code{match-data} that is | |
1404 intended to access the match data for that search. | |
1405 | |
1406 @example | |
1407 @group | |
1408 (match-data) | |
1409 @result{} (#<marker at 9 in foo> | |
1410 #<marker at 17 in foo> | |
1411 #<marker at 13 in foo> | |
1412 #<marker at 17 in foo>) | |
1413 @end group | |
1414 @end example | |
1415 @end defun | |
1416 | |
1417 @defun set-match-data match-list | |
1418 This function sets the match data from the elements of @var{match-list}, | |
1419 which should be a list that was the value of a previous call to | |
1420 @code{match-data}. | |
1421 | |
1422 If @var{match-list} refers to a buffer that doesn't exist, you don't get | |
1423 an error; that sets the match data in a meaningless but harmless way. | |
1424 | |
1425 @findex store-match-data | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1426 @code{store-match-data} is a semi-obsolete alias for @code{set-match-data}. |
6552 | 1427 @end defun |
1428 | |
1429 @node Saving Match Data | |
1430 @subsection Saving and Restoring the Match Data | |
1431 | |
10038
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1432 When you call a function that may do a search, you may need to save |
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1433 and restore the match data around that call, if you want to preserve the |
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1434 match data from an earlier search for later use. Here is an example |
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1435 that shows the problem that arises if you fail to save the match data: |
6552 | 1436 |
1437 @example | |
1438 @group | |
1439 (re-search-forward "The \\(cat \\)") | |
1440 @result{} 48 | |
1441 (foo) ; @r{Perhaps @code{foo} does} | |
1442 ; @r{more searching.} | |
1443 (match-end 0) | |
1444 @result{} 61 ; @r{Unexpected result---not 48!} | |
1445 @end group | |
1446 @end example | |
1447 | |
10038
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1448 You can save and restore the match data with @code{save-match-data}: |
6552 | 1449 |
12098 | 1450 @defmac save-match-data body@dots{} |
22252
40089afa2b1d
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
22138
diff
changeset
|
1451 This macro executes @var{body}, saving and restoring the match |
10038
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1452 data around it. |
12098 | 1453 @end defmac |
6552 | 1454 |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1455 You could use @code{set-match-data} together with @code{match-data} to |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1456 imitate the effect of the special form @code{save-match-data}. Here is |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1457 how: |
6552 | 1458 |
1459 @example | |
1460 @group | |
1461 (let ((data (match-data))) | |
1462 (unwind-protect | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1463 @dots{} ; @r{Ok to change the original match data.} |
6552 | 1464 (set-match-data data))) |
1465 @end group | |
1466 @end example | |
1467 | |
10038
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1468 Emacs automatically saves and restores the match data when it runs |
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1469 process filter functions (@pxref{Filter Functions}) and process |
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1470 sentinels (@pxref{Sentinels}). |
6b8e51b286c6
Filters and sentinels now save match data themselves.
Richard M. Stallman <rms@gnu.org>
parents:
8469
diff
changeset
|
1471 |
6552 | 1472 @ignore |
1473 Here is a function which restores the match data provided the buffer | |
1474 associated with it still exists. | |
1475 | |
1476 @smallexample | |
1477 @group | |
1478 (defun restore-match-data (data) | |
1479 @c It is incorrect to split the first line of a doc string. | |
1480 @c If there's a problem here, it should be solved in some other way. | |
1481 "Restore the match data DATA unless the buffer is missing." | |
1482 (catch 'foo | |
1483 (let ((d data)) | |
1484 @end group | |
1485 (while d | |
1486 (and (car d) | |
1487 (null (marker-buffer (car d))) | |
1488 @group | |
1489 ;; @file{match-data} @r{buffer is deleted.} | |
1490 (throw 'foo nil)) | |
1491 (setq d (cdr d))) | |
1492 (set-match-data data)))) | |
1493 @end group | |
1494 @end smallexample | |
1495 @end ignore | |
1496 | |
1497 @node Searching and Case | |
1498 @section Searching and Case | |
1499 @cindex searching and case | |
1500 | |
1501 By default, searches in Emacs ignore the case of the text they are | |
1502 searching through; if you specify searching for @samp{FOO}, then | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1503 @samp{Foo} or @samp{foo} is also considered a match. This applies to |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1504 regular expressions, too; thus, @samp{[aB]} would match @samp{a} or |
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1505 @samp{A} or @samp{b} or @samp{B}. |
6552 | 1506 |
1507 If you do not want this feature, set the variable | |
1508 @code{case-fold-search} to @code{nil}. Then all letters must match | |
8469 | 1509 exactly, including case. This is a buffer-local variable; altering the |
1510 variable affects only the current buffer. (@xref{Intro to | |
6552 | 1511 Buffer-Local}.) Alternatively, you may change the value of |
1512 @code{default-case-fold-search}, which is the default value of | |
1513 @code{case-fold-search} for buffers that do not override it. | |
1514 | |
1515 Note that the user-level incremental search feature handles case | |
1516 distinctions differently. When given a lower case letter, it looks for | |
1517 a match of either case, but when given an upper case letter, it looks | |
1518 for an upper case letter only. But this has nothing to do with the | |
21007
66d807bdc5b4
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
17886
diff
changeset
|
1519 searching functions used in Lisp code. |
6552 | 1520 |
1521 @defopt case-replace | |
8469 | 1522 This variable determines whether the replacement functions should |
1523 preserve case. If the variable is @code{nil}, that means to use the | |
1524 replacement text verbatim. A non-@code{nil} value means to convert the | |
1525 case of the replacement text according to the text being replaced. | |
1526 | |
25751
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1527 This variable is used by passing it as an argument to the function |
467b88fab665
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
25089
diff
changeset
|
1528 @code{replace-match}. @xref{Replacing Match}. |
6552 | 1529 @end defopt |
1530 | |
1531 @defopt case-fold-search | |
1532 This buffer-local variable determines whether searches should ignore | |
1533 case. If the variable is @code{nil} they do not ignore case; otherwise | |
1534 they do ignore case. | |
1535 @end defopt | |
1536 | |
1537 @defvar default-case-fold-search | |
1538 The value of this variable is the default value for | |
1539 @code{case-fold-search} in buffers that do not override it. This is the | |
1540 same as @code{(default-value 'case-fold-search)}. | |
1541 @end defvar | |
1542 | |
1543 @node Standard Regexps | |
1544 @section Standard Regular Expressions Used in Editing | |
1545 @cindex regexps used standardly in editing | |
1546 @cindex standard regexps used in editing | |
1547 | |
1548 This section describes some variables that hold regular expressions | |
1549 used for certain purposes in editing: | |
1550 | |
1551 @defvar page-delimiter | |
21682
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1552 This is the regular expression describing line-beginnings that separate |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1553 pages. The default value is @code{"^\014"} (i.e., @code{"^^L"} or |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1554 @code{"^\C-l"}); this matches a line that starts with a formfeed |
90da2489c498
*** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents:
21007
diff
changeset
|
1555 character. |
6552 | 1556 @end defvar |
1557 | |
12067 | 1558 The following two regular expressions should @emph{not} assume the |
1559 match always starts at the beginning of a line; they should not use | |
1560 @samp{^} to anchor the match. Most often, the paragraph commands do | |
1561 check for a match only at the beginning of a line, which means that | |
12098 | 1562 @samp{^} would be superfluous. When there is a nonzero left margin, |
1563 they accept matches that start after the left margin. In that case, a | |
1564 @samp{^} would be incorrect. However, a @samp{^} is harmless in modes | |
1565 where a left margin is never used. | |
12067 | 1566 |
6552 | 1567 @defvar paragraph-separate |
1568 This is the regular expression for recognizing the beginning of a line | |
1569 that separates paragraphs. (If you change this, you may have to | |
8469 | 1570 change @code{paragraph-start} also.) The default value is |
12067 | 1571 @w{@code{"[@ \t\f]*$"}}, which matches a line that consists entirely of |
1572 spaces, tabs, and form feeds (after its left margin). | |
6552 | 1573 @end defvar |
1574 | |
1575 @defvar paragraph-start | |
1576 This is the regular expression for recognizing the beginning of a line | |
1577 that starts @emph{or} separates paragraphs. The default value is | |
12067 | 1578 @w{@code{"[@ \t\n\f]"}}, which matches a line starting with a space, tab, |
1579 newline, or form feed (after its left margin). | |
6552 | 1580 @end defvar |
1581 | |
1582 @defvar sentence-end | |
1583 This is the regular expression describing the end of a sentence. (All | |
1584 paragraph boundaries also end sentences, regardless.) The default value | |
1585 is: | |
1586 | |
1587 @example | |
8469 | 1588 "[.?!][]\"')@}]*\\($\\| $\\|\t\\| \\)[ \t\n]*" |
6552 | 1589 @end example |
1590 | |
8469 | 1591 This means a period, question mark or exclamation mark, followed |
1592 optionally by a closing parenthetical character, followed by tabs, | |
1593 spaces or new lines. | |
6552 | 1594 |
1595 For a detailed explanation of this regular expression, see @ref{Regexp | |
1596 Example}. | |
1597 @end defvar |