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