module Netstring_pcre:sig..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!
OPAM users: Note that the OPAM package for OCamlnet does not
build with PCRE support by default. The trigger for this is the presence
of the pcre OPAM package, i.e. do opam install pcre
to include the netstring-pcre library in a rebuild.
typeregexp =Pcre.regexp
Pcretypesplit_result =Pcre.split_result=
| |
Text of |
|||
| |
Delim of |
|||
| |
Group of |
|||
| |
NoGroup |
(* |
Here we keep compatiblity with
Pcre | *) |
type result
val regexp : string -> regexpval regexp_case_fold : string -> regexpval quote : string -> stringval regexp_string : string -> regexpval regexp_string_case_fold : string -> regexpval string_match : regexp -> string -> int -> result optionNone if no match is found. Returns Some r on success,
and r describes the match.val bytes_match : regexp -> Bytes.t -> int -> result optionval search_forward : regexp -> string -> int -> int * resultNot_found if no match could be found.
Returns (p,r) when a match at position p is found,
described by r.val search_forward_bytes : regexp -> Bytes.t -> int -> int * resultval search_backward : regexp -> string -> int -> int * resultNot_found if no match could be found.
Returns (p,r) when a match at position p is found,
described by r.val search_backward_bytes : regexp -> Bytes.t -> int -> int * resultval matched_string : result -> string -> stringstring_match or the search
functions, and the result argument must be the corresponding
result.val matched_bytes : result -> Bytes.t -> Bytes.tval match_beginning : result -> intval match_end : result -> intval matched_group : result -> int -> string -> stringstring_match or the search
functions, and the result argument must be the corresponding
result.val matched_group_bytes : result -> int -> Bytes.t -> Bytes.tval group_beginning : result -> int -> intval group_end : result -> int -> intval global_replace : regexp -> string -> string -> stringglobal_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 replace_first : regexp -> string -> string -> stringreplace_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 global_substitute : regexp ->
(result -> string -> string) -> string -> stringglobal_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 substitute_first : regexp ->
(result -> string -> string) -> string -> stringsubstitute_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 split : regexp -> string -> string listval bounded_split : regexp -> string -> int -> string listn substrings, based on splitval split_delim : regexp -> string -> string listsplit, but occurrences of the delimiter at the beginning
and the end are returned as empty stringsval bounded_split_delim : regexp -> string -> int -> string listn substrings, based on split_delimval full_split : regexp -> string -> split_result listsplit_delim, but returns the delimiters in the resultval bounded_full_split : regexp -> string -> int -> split_result listn substrings, based on full_splitval string_before : string -> int -> stringn characters of a stringval string_after : string -> int -> stringn characters of a stringval first_chars : string -> int -> stringstring_beforeval last_chars : string -> int -> stringstring_after