/[pcre]/code/trunk/doc/pcreapi.3
ViewVC logotype

Diff of /code/trunk/doc/pcreapi.3

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 227 by ph10, Tue Aug 21 15:00:15 2007 UTC revision 312 by ph10, Wed Jan 23 18:02:23 2008 UTC
# Line 140  distribution. The Line 140  distribution. The
140  .\" HREF  .\" HREF
141  \fBpcresample\fP  \fBpcresample\fP
142  .\"  .\"
143  documentation describes how to run it.  documentation describes how to compile and run it.
144  .P  .P
145  A second matching function, \fBpcre_dfa_exec()\fP, which is not  A second matching function, \fBpcre_dfa_exec()\fP, which is not
146  Perl-compatible, is also provided. This uses a different algorithm for the  Perl-compatible, is also provided. This uses a different algorithm for the
# Line 254  non-anchored pattern. There is more deta Line 254  non-anchored pattern. There is more deta
254  .\" </a>  .\" </a>
255  section on \fBpcre_exec()\fP options  section on \fBpcre_exec()\fP options
256  .\"  .\"
257  below. The choice of newline convention does not affect the interpretation of  below.
258  the \en or \er escape sequences.  .P
259    The choice of newline convention does not affect the interpretation of
260    the \en or \er escape sequences, nor does it affect what \eR matches, which is
261    controlled in a similar way, but by separate options.
262  .  .
263  .  .
264  .SH MULTITHREADING  .SH MULTITHREADING
# Line 317  that is recognized as meaning "newline". Line 320  that is recognized as meaning "newline".
320  are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY. The  are: 10 for LF, 13 for CR, 3338 for CRLF, -2 for ANYCRLF, and -1 for ANY. The
321  default should normally be the standard sequence for your operating system.  default should normally be the standard sequence for your operating system.
322  .sp  .sp
323      PCRE_CONFIG_BSR
324    .sp
325    The output is an integer whose value indicates what character sequences the \eR
326    escape sequence matches by default. A value of 0 means that \eR matches any
327    Unicode line ending sequence; a value of 1 means that \eR matches only CR, LF,
328    or CRLF. The default can be overridden when a pattern is compiled or matched.
329    .sp
330    PCRE_CONFIG_LINK_SIZE    PCRE_CONFIG_LINK_SIZE
331  .sp  .sp
332  The output is an integer that contains the number of bytes used for internal  The output is an integer that contains the number of bytes used for internal
# Line 458  facility, see the Line 468  facility, see the
468  .\"  .\"
469  documentation.  documentation.
470  .sp  .sp
471      PCRE_BSR_ANYCRLF
472      PCRE_BSR_UNICODE
473    .sp
474    These options (which are mutually exclusive) control what the \eR escape
475    sequence matches. The choice is either to match only CR, LF, or CRLF, or to
476    match any Unicode newline sequence. The default is specified when PCRE is
477    built. It can be overridden from within the pattern, or by setting an option
478    when a compiled pattern is matched.
479    .sp
480    PCRE_CASELESS    PCRE_CASELESS
481  .sp  .sp
482  If this bit is set, letters in the pattern match both upper and lower case  If this bit is set, letters in the pattern match both upper and lower case
# Line 653  out of use. To avoid confusion, they hav Line 672  out of use. To avoid confusion, they hav
672     9  nothing to repeat     9  nothing to repeat
673    10  [this code is not in use]    10  [this code is not in use]
674    11  internal error: unexpected repeat    11  internal error: unexpected repeat
675    12  unrecognized character after (?    12  unrecognized character after (? or (?-
676    13  POSIX named classes are supported only within a class    13  POSIX named classes are supported only within a class
677    14  missing )    14  missing )
678    15  reference to non-existent subpattern    15  reference to non-existent subpattern
# Line 661  out of use. To avoid confusion, they hav Line 680  out of use. To avoid confusion, they hav
680    17  unknown option bit(s) set    17  unknown option bit(s) set
681    18  missing ) after comment    18  missing ) after comment
682    19  [this code is not in use]    19  [this code is not in use]
683    20  regular expression too large    20  regular expression is too large
684    21  failed to get memory    21  failed to get memory
685    22  unmatched parentheses    22  unmatched parentheses
686    23  internal error: code overflow    23  internal error: code overflow
# Line 690  out of use. To avoid confusion, they hav Line 709  out of use. To avoid confusion, they hav
709    46  malformed \eP or \ep sequence    46  malformed \eP or \ep sequence
710    47  unknown property name after \eP or \ep    47  unknown property name after \eP or \ep
711    48  subpattern name is too long (maximum 32 characters)    48  subpattern name is too long (maximum 32 characters)
712    49  too many named subpatterns (maximum 10,000)    49  too many named subpatterns (maximum 10000)
713    50  [this code is not in use]    50  [this code is not in use]
714    51  octal value is greater than \e377 (not in UTF-8 mode)    51  octal value is greater than \e377 (not in UTF-8 mode)
715    52  internal error: overran compiling workspace    52  internal error: overran compiling workspace
716    53  internal error: previously-checked referenced subpattern not found    53  internal error: previously-checked referenced subpattern not found
717    54  DEFINE group contains more than one branch    54  DEFINE group contains more than one branch
718    55  repeating a DEFINE group is not allowed    55  repeating a DEFINE group is not allowed
719    56  inconsistent NEWLINE options"    56  inconsistent NEWLINE options
720    57  \eg is not followed by a braced name or an optionally braced    57  \eg is not followed by a braced name or an optionally braced
721          non-zero number          non-zero number
722    58  (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number    58  (?+ or (?- or (?(+ or (?(- must be followed by a non-zero number
723      59  (*VERB) with an argument is not supported
724      60  (*VERB) not recognized
725      61  number is too big
726      62  subpattern name expected
727      63  digit expected after (?+
728    .sp
729    The numbers 32 and 10000 in errors 48 and 49 are defaults; different values may
730    be used if the limits were changed when PCRE was built.
731  .  .
732  .  .
733  .SH "STUDYING A PATTERN"  .SH "STUDYING A PATTERN"
# Line 899  fourth argument should point to an \fBun Line 926  fourth argument should point to an \fBun
926    PCRE_INFO_HASCRORLF    PCRE_INFO_HASCRORLF
927  .sp  .sp
928  Return 1 if the pattern contains any explicit matches for CR or LF characters,  Return 1 if the pattern contains any explicit matches for CR or LF characters,
929  otherwise 0. The fourth argument should point to an \fBint\fP variable.  otherwise 0. The fourth argument should point to an \fBint\fP variable. An
930    explicit match is either a literal CR or LF character, or \er or \en.
931  .sp  .sp
932    PCRE_INFO_JCHANGED    PCRE_INFO_JCHANGED
933  .sp  .sp
934  Return 1 if the (?J) option setting is used in the pattern, otherwise 0. The  Return 1 if the (?J) or (?-J) option setting is used in the pattern, otherwise
935  fourth argument should point to an \fBint\fP variable. The (?J) internal option  0. The fourth argument should point to an \fBint\fP variable. (?J) and
936  setting changes the local PCRE_DUPNAMES option.  (?-J) set and unset the local PCRE_DUPNAMES option, respectively.
937  .sp  .sp
938    PCRE_INFO_LASTLITERAL    PCRE_INFO_LASTLITERAL
939  .sp  .sp
# Line 1203  matching position. If a pattern was comp Line 1231  matching position. If a pattern was comp
1231  to be anchored by virtue of its contents, it cannot be made unachored at  to be anchored by virtue of its contents, it cannot be made unachored at
1232  matching time.  matching time.
1233  .sp  .sp
1234      PCRE_BSR_ANYCRLF
1235      PCRE_BSR_UNICODE
1236    .sp
1237    These options (which are mutually exclusive) control what the \eR escape
1238    sequence matches. The choice is either to match only CR, LF, or CRLF, or to
1239    match any Unicode newline sequence. These options override the choice that was
1240    made or defaulted when the pattern was compiled.
1241    .sp
1242    PCRE_NEWLINE_CR    PCRE_NEWLINE_CR
1243    PCRE_NEWLINE_LF    PCRE_NEWLINE_LF
1244    PCRE_NEWLINE_CRLF    PCRE_NEWLINE_CRLF
# Line 1218  pattern. Line 1254  pattern.
1254  .P  .P
1255  When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is set, and a  When PCRE_NEWLINE_CRLF, PCRE_NEWLINE_ANYCRLF, or PCRE_NEWLINE_ANY is set, and a
1256  match attempt for an unanchored pattern fails when the current position is at a  match attempt for an unanchored pattern fails when the current position is at a
1257  CRLF sequence, and the pattern contains no explicit matches for CR or NL  CRLF sequence, and the pattern contains no explicit matches for CR or LF
1258  characters, the match position is advanced by two characters instead of one, in  characters, the match position is advanced by two characters instead of one, in
1259  other words, to after the CRLF.  other words, to after the CRLF.
1260  .P  .P
# Line 1228  set), it does not match the string "\er\ Line 1264  set), it does not match the string "\er\
1264  start, it skips both the CR and the LF before retrying. However, the pattern  start, it skips both the CR and the LF before retrying. However, the pattern
1265  [\er\en]A does match that string, because it contains an explicit CR or LF  [\er\en]A does match that string, because it contains an explicit CR or LF
1266  reference, and so advances only by one character after the first failure.  reference, and so advances only by one character after the first failure.
1267  Note than an explicit CR or LF reference occurs for negated character classes  .P
1268  such as [^X] because they can match CR or LF characters.  An explicit match for CR of LF is either a literal appearance of one of those
1269    characters, or one of the \er or \en escape sequences. Implicit matches such as
1270    [^X] do not count, nor does \es (which includes CR and LF in the characters
1271    that it matches).
1272  .P  .P
1273  Notwithstanding the above, anomalous effects may still occur when CRLF is a  Notwithstanding the above, anomalous effects may still occur when CRLF is a
1274  valid newline sequence and explicit \er or \en escapes appear in the pattern.  valid newline sequence and explicit \er or \en escapes appear in the pattern.
# Line 1921  Cambridge CB2 3QH, England. Line 1960  Cambridge CB2 3QH, England.
1960  .rs  .rs
1961  .sp  .sp
1962  .nf  .nf
1963  Last updated: 21 August 2007  Last updated: 23 January 2008
1964  Copyright (c) 1997-2007 University of Cambridge.  Copyright (c) 1997-2008 University of Cambridge.
1965  .fi  .fi

Legend:
Removed from v.227  
changed lines
  Added in v.312

  ViewVC Help
Powered by ViewVC 1.1.5