lib/libc/regex/re_format.7

   1 .\" Copyright (c) 1992, 1993, 1994 Henry Spencer.
   2 .\" Copyright (c) 1992, 1993, 1994
   3 .\"     The Regents of the University of California.  All rights reserved.
   4 .\"
   5 .\" This code is derived from software contributed to Berkeley by
   6 .\" Henry Spencer.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)re_format.7 8.3 (Berkeley) 3/20/94
  37 .\" $FreeBSD: src/lib/libc/regex/re_format.7,v 1.4.2.5 2002/01/22 12:40:10 ru Exp $
  38 .\" $DragonFly: src/lib/libc/regex/re_format.7,v 1.3 2008/05/02 02:05:04 swildner Exp $
  39 .\"
  40 .Dd March 20, 1994
  41 .Dt RE_FORMAT 7
  42 .Os
  43 .Sh NAME
  44 .Nm re_format
  45 .Nd POSIX 1003.2 regular expressions
  46 .Sh DESCRIPTION
  47 Regular expressions
  48 .Pq Dq RE Ns s ,
  49 as defined in
  50 .St -p1003.2 ,
  51 come in two forms:
  52 modern REs (roughly those of
  53 .Xr egrep 1 ;
  54 1003.2 calls these
  55 .Dq extended
  56 REs)
  57 and obsolete REs (roughly those of
  58 .Xr ed 1 ;
  59 1003.2
  60 .Dq basic
  61 REs).
  62 Obsolete REs mostly exist for backward compatibility in some old programs;
  63 they will be discussed at the end.
  64 .St -p1003.2
  65 leaves some aspects of RE syntax and semantics open;
  66 `\(dd' marks decisions on these aspects that
  67 may not be fully portable to other
  68 .St -p1003.2
  69 implementations.
  70 .Pp
  71 A (modern) RE is one\(dd or more non-empty\(dd
  72 .Em branches ,
  73 separated by
  74 .Ql \&| .
  75 It matches anything that matches one of the branches.
  76 .Pp
  77 A branch is one\(dd or more
  78 .Em pieces ,
  79 concatenated.
  80 It matches a match for the first, followed by a match for the second, etc.
  81 .Pp
  82 A piece is an
  83 .Em atom
  84 possibly followed
  85 by a single\(dd
  86 .Ql \&* ,
  87 .Ql \&+ ,
  88 .Ql \&? ,
  89 or
  90 .Em bound .
  91 An atom followed by
  92 .Ql \&*
  93 matches a sequence of 0 or more matches of the atom.
  94 An atom followed by
  95 .Ql \&+
  96 matches a sequence of 1 or more matches of the atom.
  97 An atom followed by
  98 .Ql ?\&
  99 matches a sequence of 0 or 1 matches of the atom.
 100 .Pp
 101 A
 102 .Em bound
 103 is
 104 .Ql \&{
 105 followed by an unsigned decimal integer,
 106 possibly followed by
 107 .Ql \&,
 108 possibly followed by another unsigned decimal integer,
 109 always followed by
 110 .Ql \&} .
 111 The integers must lie between 0 and
 112 .Dv RE_DUP_MAX
 113 (255\(dd) inclusive,
 114 and if there are two of them, the first may not exceed the second.
 115 An atom followed by a bound containing one integer
 116 .Em i
 117 and no comma matches
 118 a sequence of exactly
 119 .Em i
 120 matches of the atom.
 121 An atom followed by a bound
 122 containing one integer
 123 .Em i
 124 and a comma matches
 125 a sequence of
 126 .Em i
 127 or more matches of the atom.
 128 An atom followed by a bound
 129 containing two integers
 130 .Em i
 131 and
 132 .Em j
 133 matches
 134 a sequence of
 135 .Em i
 136 through
 137 .Em j
 138 (inclusive) matches of the atom.
 139 .Pp
 140 An atom is a regular expression enclosed in
 141 .Ql ()
 142 (matching a match for the
 143 regular expression),
 144 an empty set of
 145 .Ql ()
 146 (matching the null string)\(dd,
 147 a
 148 .Em bracket expression
 149 (see below),
 150 .Ql .\&
 151 (matching any single character),
 152 .Ql \&^
 153 (matching the null string at the beginning of a line),
 154 .Ql \&$
 155 (matching the null string at the end of a line), a
 156 .Ql \e
 157 followed by one of the characters
 158 .Ql ^.[$()|*+?{\e
 159 (matching that character taken as an ordinary character),
 160 a
 161 .Ql \e
 162 followed by any other character\(dd
 163 (matching that character taken as an ordinary character,
 164 as if the
 165 .Ql \e
 166 had not been present\(dd),
 167 or a single character with no other significance (matching that character).
 168 A
 169 .Ql \&{
 170 followed by a character other than a digit is an ordinary
 171 character, not the beginning of a bound\(dd.
 172 It is illegal to end an RE with
 173 .Ql \e .
 174 .Pp
 175 A
 176 .Em bracket expression
 177 is a list of characters enclosed in
 178 .Ql [] .
 179 It normally matches any single character from the list (but see below).
 180 If the list begins with
 181 .Ql \&^ ,
 182 it matches any single character
 183 (but see below)
 184 .Em not
 185 from the rest of the list.
 186 If two characters in the list are separated by
 187 .Ql \&- ,
 188 this is shorthand
 189 for the full
 190 .Em range
 191 of characters between those two (inclusive) in the
 192 collating sequence,
 193 .No e.g. Ql [0-9]
 194 in ASCII matches any decimal digit.
 195 It is illegal\(dd for two ranges to share an
 196 endpoint,
 197 .No e.g. Ql a-c-e .
 198 Ranges are very collating-sequence-dependent,
 199 and portable programs should avoid relying on them.
 200 .Pp
 201 To include a literal
 202 .Ql \&]
 203 in the list, make it the first character
 204 (following a possible
 205 .Ql \&^ ) .
 206 To include a literal
 207 .Ql \&- ,
 208 make it the first or last character,
 209 or the second endpoint of a range.
 210 To use a literal
 211 .Ql \&-
 212 as the first endpoint of a range,
 213 enclose it in
 214 .Ql [.\&
 215 and
 216 .Ql .]\&
 217 to make it a collating element (see below).
 218 With the exception of these and some combinations using
 219 .Ql \&[
 220 (see next paragraphs), all other special characters, including
 221 .Ql \e ,
 222 lose their special significance within a bracket expression.
 223 .Pp
 224 Within a bracket expression, a collating element (a character,
 225 a multi-character sequence that collates as if it were a single character,
 226 or a collating-sequence name for either)
 227 enclosed in
 228 .Ql [.\&
 229 and
 230 .Ql .]\&
 231 stands for the
 232 sequence of characters of that collating element.
 233 The sequence is a single element of the bracket expression's list.
 234 A bracket expression containing a multi-character collating element
 235 can thus match more than one character,
 236 e.g. if the collating sequence includes a
 237 .Ql ch
 238 collating element,
 239 then the RE
 240 .Ql [[.ch.]]*c
 241 matches the first five characters
 242 of
 243 .Ql chchcc .
 244 .Pp
 245 Within a bracket expression, a collating element enclosed in
 246 .Ql [=
 247 and
 248 .Ql =]
 249 is an equivalence class, standing for the sequences of characters
 250 of all collating elements equivalent to that one, including itself.
 251 (If there are no other equivalent collating elements,
 252 the treatment is as if the enclosing delimiters were
 253 .Ql [.\&
 254 and
 255 .Ql .] . )
 256 For example, if
 257 .Ql x
 258 and
 259 .Ql y
 260 are the members of an equivalence class,
 261 then
 262 .Ql [[=x=]] ,
 263 .Ql [[=y=]] ,
 264 and
 265 .Ql [xy]
 266 are all synonymous.
 267 An equivalence class may not\(dd be an endpoint
 268 of a range.
 269 .Pp
 270 Within a bracket expression, the name of a
 271 .Em character class
 272 enclosed in
 273 .Ql [:
 274 and
 275 .Ql :]
 276 stands for the list of all characters belonging to that
 277 class.
 278 Standard character class names are:
 279 .Bl -column "alnum" "digit" "xdigit" -offset indent
 280 .It Em "alnum   digit   punct"
 281 .It Em "alpha   graph   space"
 282 .It Em "blank   lower   upper"
 283 .It Em "cntrl   print   xdigit"
 284 .El
 285 .Pp
 286 These stand for the character classes defined in
 287 .Xr ctype 3 .
 288 A locale may provide others.
 289 A character class may not be used as an endpoint of a range.
 290 .Pp
 291 There are two special cases\(dd of bracket expressions:
 292 the bracket expressions
 293 .Ql [[:<:]]
 294 and
 295 .Ql [[:>:]]
 296 match the null string at the beginning and end of a word respectively.
 297 A word is defined as a sequence of word characters
 298 which is neither preceded nor followed by
 299 word characters.
 300 A word character is an
 301 .Em alnum
 302 character (as defined by
 303 .Xr ctype 3 )
 304 or an underscore.
 305 This is an extension,
 306 compatible with but not specified by
 307 .St -p1003.2 ,
 308 and should be used with
 309 caution in software intended to be portable to other systems.
 310 .Pp
 311 In the event that an RE could match more than one substring of a given
 312 string,
 313 the RE matches the one starting earliest in the string.
 314 If the RE could match more than one substring starting at that point,
 315 it matches the longest.
 316 Subexpressions also match the longest possible substrings, subject to
 317 the constraint that the whole match be as long as possible,
 318 with subexpressions starting earlier in the RE taking priority over
 319 ones starting later.
 320 Note that higher-level subexpressions thus take priority over
 321 their lower-level component subexpressions.
 322 .Pp
 323 Match lengths are measured in characters, not collating elements.
 324 A null string is considered longer than no match at all.
 325 For example,
 326 .Ql bb*
 327 matches the three middle characters of
 328 .Ql abbbc ,
 329 .Ql (wee|week)(knights|nights)
 330 matches all ten characters of
 331 .Ql weeknights ,
 332 when
 333 .Ql (.*).*\&
 334 is matched against
 335 .Ql abc
 336 the parenthesized subexpression
 337 matches all three characters, and
 338 when
 339 .Ql (a*)*
 340 is matched against
 341 .Ql bc
 342 both the whole RE and the parenthesized
 343 subexpression match the null string.
 344 .Pp
 345 If case-independent matching is specified,
 346 the effect is much as if all case distinctions had vanished from the
 347 alphabet.
 348 When an alphabetic that exists in multiple cases appears as an
 349 ordinary character outside a bracket expression, it is effectively
 350 transformed into a bracket expression containing both cases,
 351 .No e.g. Ql x
 352 becomes
 353 .Ql [xX] .
 354 When it appears inside a bracket expression, all case counterparts
 355 of it are added to the bracket expression, so that (e.g.)
 356 .Ql [x]
 357 becomes
 358 .Ql [xX]
 359 and
 360 .Ql [^x]
 361 becomes
 362 .Ql [^xX] .
 363 .Pp
 364 No particular limit is imposed on the length of REs\(dd.
 365 Programs intended to be portable should not employ REs longer
 366 than 256 bytes,
 367 as an implementation can refuse to accept such REs and remain
 368 POSIX-compliant.
 369 .Pp
 370 Obsolete
 371 .Pq Dq basic
 372 regular expressions differ in several respects.
 373 .Ql \&|
 374 is an ordinary character and there is no equivalent
 375 for its functionality.
 376 .Ql \&+
 377 and
 378 .Ql ?\&
 379 are ordinary characters, and their functionality
 380 can be expressed using bounds
 381 .No ( Ql {1,}
 382 or
 383 .Ql {0,1}
 384 respectively).
 385 Also note that
 386 .Ql x+
 387 in modern REs is equivalent to
 388 .Ql xx* .
 389 The delimiters for bounds are
 390 .Ql \e{
 391 and
 392 .Ql \e} ,
 393 with
 394 .Ql \&{
 395 and
 396 .Ql \&}
 397 by themselves ordinary characters.
 398 The parentheses for nested subexpressions are
 399 .Ql \e(
 400 and
 401 .Ql \e) ,
 402 with
 403 .Ql \&(
 404 and
 405 .Ql \&)
 406 by themselves ordinary characters.
 407 .Ql \&^
 408 is an ordinary character except at the beginning of the
 409 RE or\(dd the beginning of a parenthesized subexpression,
 410 .Ql \&$
 411 is an ordinary character except at the end of the
 412 RE or\(dd the end of a parenthesized subexpression,
 413 and
 414 .Ql \&*
 415 is an ordinary character if it appears at the beginning of the
 416 RE or the beginning of a parenthesized subexpression
 417 (after a possible leading
 418 .Ql \&^ ) .
 419 Finally, there is one new type of atom, a
 420 .Em back reference :
 421 .Ql \e
 422 followed by a non-zero decimal digit
 423 .Em d
 424 matches the same sequence of characters
 425 matched by the
 426 .Em d Ns th
 427 parenthesized subexpression
 428 (numbering subexpressions by the positions of their opening parentheses,
 429 left to right),
 430 so that (e.g.)
 431 .Ql \e([bc]\e)\e1
 432 matches
 433 .Ql bb
 434 or
 435 .Ql cc
 436 but not
 437 .Ql bc .
 438 .Sh SEE ALSO
 439 .Xr regex 3
 440 .Rs
 441 .%T Regular Expression Notation
 442 .%R IEEE Std
 443 .%N 1003.2
 444 .%P section 2.8
 445 .Re
 446 .Sh BUGS
 447 Having two kinds of REs is a botch.
 448 .Pp
 449 The current
 450 .St -p1003.2
 451 spec says that
 452 .Ql \&)
 453 is an ordinary character in
 454 the absence of an unmatched
 455 .Ql \&( ;
 456 this was an unintentional result of a wording error,
 457 and change is likely.
 458 Avoid relying on it.
 459 .Pp
 460 Back references are a dreadful botch,
 461 posing major problems for efficient implementations.
 462 They are also somewhat vaguely defined
 463 (does
 464 .Ql a\e(\e(b\e)*\e2\e)*d
 465 match
 466 .Ql abbbd ? ) .
 467 Avoid using them.
 468 .Pp
 469 .St -p1003.2
 470 specification of case-independent matching is vague.
 471 The
 472 .Dq one case implies all cases
 473 definition given above
 474 is current consensus among implementors as to the right interpretation.
 475 .Pp
 476 The syntax for word boundaries is incredibly ugly.