module Netstring_pcre:Wrapper for regexps with PCRE syntaxsig
..end
This module is a version of Str
with a thread-safe interface,
implemented using Pcre.
This modules processes PCRE-style regular expressions. If you like
to write Str
-like regexps, you can also use Netstring_str
with
almost the same signature.
The functions in this module are unavailable if Ocamlnet is built
with Str
as implementation of regular expressions! They will always
raise Invalid_argument
!
typeregexp =
Pcre.regexp
typesplit_result =
Pcre.split_result
=
| |
Text of |
| |
Delim of |
| |
Group of |
| |
NoGroup |
Pcre
type
result
Pcre
val regexp : string -> regexp
val regexp_case_fold : string -> regexp
val quote : string -> string
val regexp_string : string -> regexp
val regexp_string_case_fold : string -> regexp
val string_match : regexp -> string -> int -> result option
val search_forward : regexp -> string -> int -> int * result
None
if no match is found. Returns Some r
on success,
and r
describes the match.val search_backward : regexp -> string -> int -> int * result
Not_found
if no match could be found.
Returns (p,r)
when a match at position p
is found,
described by r
.val matched_string : result -> string -> string
Not_found
if no match could be found.
Returns (p,r)
when a match at position p
is found,
described by r
.val match_beginning : result -> int
string_match
or the search
functions, and the result argument must be the corresponding
result.val match_end : result -> int
val matched_group : result -> int -> string -> string
val group_beginning : result -> int -> int
string_match
or the search
functions, and the result argument must be the corresponding
result.val group_end : result -> int -> int
val global_replace : regexp -> string -> string -> string
val replace_first : regexp -> string -> string -> string
global_replace re templ s
: Replaces all matchings of re
in
s
by templ
.
In templ
one can refer to matched groups by the backslash notation:
\1
refers to the first group, \2
to the second etc.
\0
is the whole match. \\
is the backslash character.
val global_substitute : regexp ->
(result -> string -> string) -> string -> string
replace_first re templ s
: Replaces the first match of re
in
s
by templ
.
In templ
one can refer to matched groups by the backslash notation:
\1
refers to the first group, \2
to the second etc.
\0
is the whole match. \\
is the backslash character.
val substitute_first : regexp ->
(result -> string -> string) -> string -> string
global_substitute re subst s
: Applies the substitution function
subst
to all matchings of re
in s
, and returns the
transformed string. subst
is called with the current result
of the match and the whole string s
.val split : regexp -> string -> string list
substitute_first re subst s
: Applies the substitution function
subst
to the first matching of re
in s
, and returns the
transformed string. subst
is called with the current result
of the match and the whole string s
.val bounded_split : regexp -> string -> int -> string list
val split_delim : regexp -> string -> string list
n
substrings, based on split
val bounded_split_delim : regexp -> string -> int -> string list
split
, but occurrences of the delimiter at the beginning
and the end are returned as empty stringsval full_split : regexp -> string -> split_result list
n
substrings, based on split_delim
val bounded_full_split : regexp -> string -> int -> split_result list
split_delim
, but returns the delimiters in the resultval string_before : string -> int -> string
n
substrings, based on full_split
val string_after : string -> int -> string
n
characters of a stringval first_chars : string -> int -> string
n
characters of a stringval last_chars : string -> int -> string
string_before