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