package re

  1. Overview
  2. Docs
RE is a regular expression library for OCaml

Install

Dune Dependency

github.com Readme Changelog LGPL-2.0-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (19)

Authors

  1. J
    Jerome Vouillon
  2. T
    Thomas Gazagnaire
  3. A
    Anil Madhavapeddy
  4. R
    Rudi Grinberg
  5. Gabriel Radanne

Maintainers

  1. R
    rudi.grinberg@gmail.com

Sources

re-1.7.3.tbz
sha256=d9674725760f926c6f4687bc8d449d6db8f839551a6ecc5288c923eaf018695b
md5=d2a74ca77216861bce4449600a132de9

doc/re/Re/index.html

Module ReSource

Module Re: regular expressions commons

Sourcetype t

Regular expression

Sourcetype re

Compiled regular expression

Sourcetype groups

Information about groups in a match.

Compilation and execution of a regular expression

Sourceval compile : t -> re

Compile a regular expression into an executable version that can be used to match strings, e.g. with exec.

Sourceval exec : ?pos:int -> ?len:int -> re -> string -> groups

exec re str matches str against the compiled expression re, and returns the matched groups if any.

  • parameter pos

    optional beginning of the string (default 0)

  • parameter len

    length of the substring of str that can be matched (default -1, meaning to the end of the string

  • raises Not_found

    if the regular expression can't be found in str

Sourceval exec_opt : ?pos:int -> ?len:int -> re -> string -> groups option

Similar to exec, but returns an option instead of using an exception.

Sourceval execp : ?pos:int -> ?len:int -> re -> string -> bool

Similar to exec, but returns true if the expression matches, and false if it doesn't

Sourceval exec_partial : ?pos:int -> ?len:int -> re -> string -> [ `Full | `Partial | `Mismatch ]

More detailed version of exec_p

Sourcemodule Group : sig ... end

Manipulate matching groups.

Sourcemodule Mark : sig ... end

Marks

High Level Operations

Sourcetype 'a gen = unit -> 'a option
Sourceval all : ?pos:int -> ?len:int -> re -> string -> Group.t list

Repeatedly calls exec on the given string, starting at given position and length.

Sourceval all_gen : ?pos:int -> ?len:int -> re -> string -> Group.t gen

Same as all but returns a generator

Sourceval matches : ?pos:int -> ?len:int -> re -> string -> string list

Same as all, but extracts the matched substring rather than returning the whole group. This basically iterates over matched strings

Sourceval matches_gen : ?pos:int -> ?len:int -> re -> string -> string gen

Same as matches, but returns a generator.

Sourceval split : ?pos:int -> ?len:int -> re -> string -> string list

split re s splits s into chunks separated by re. It yields the chunks themselves, not the separator. For instance this can be used with a whitespace-matching re such as "[\t ]+".

Sourceval split_gen : ?pos:int -> ?len:int -> re -> string -> string gen
Sourcetype split_token = [
  1. | `Text of string
    (*

    Text between delimiters

    *)
  2. | `Delim of Group.t
    (*

    Delimiter

    *)
]
Sourceval split_full : ?pos:int -> ?len:int -> re -> string -> split_token list
Sourceval split_full_gen : ?pos:int -> ?len:int -> re -> string -> split_token gen
Sourceval replace : ?pos:int -> ?len:int -> ?all:bool -> re -> f:(Group.t -> string) -> string -> string

replace ~all re ~f s iterates on s, and replaces every occurrence of re with f substring where substring is the current match. If all = false, then only the first occurrence of re is replaced.

Sourceval replace_string : ?pos:int -> ?len:int -> ?all:bool -> re -> by:string -> string -> string

replace_string ~all re ~by s iterates on s, and replaces every occurrence of re with by. If all = false, then only the first occurrence of re is replaced.

String expressions (literal match)

Sourceval str : string -> t
Sourceval char : char -> t

Basic operations on regular expressions

Sourceval alt : t list -> t

Alternative

Sourceval seq : t list -> t

Sequence

Sourceval empty : t

Match nothing

Sourceval epsilon : t

Empty word

Sourceval rep : t -> t

0 or more matches

Sourceval rep1 : t -> t

1 or more matches

Sourceval repn : t -> int -> int option -> t

repn re i j matches re at least i times and at most j times, bounds included. j = None means no upper bound.

Sourceval opt : t -> t

0 or 1 matches

String, line, word

Sourceval bol : t

Beginning of line

Sourceval eol : t

End of line

Sourceval bow : t

Beginning of word

Sourceval eow : t

End of word

Sourceval bos : t

Beginning of string

Sourceval eos : t

End of string

Sourceval leol : t

Last end of line or end of string

Sourceval start : t

Initial position

Sourceval stop : t

Final position

Sourceval word : t -> t

Word

Sourceval not_boundary : t

Not at a word boundary

Sourceval whole_string : t -> t

Only matches the whole string

Match semantics

Sourceval longest : t -> t

Longest match

Sourceval shortest : t -> t

Shortest match

Sourceval first : t -> t

First match

Repeated match modifiers

Sourceval greedy : t -> t

Greedy

Sourceval non_greedy : t -> t

Non-greedy

Groups (or submatches)

Sourceval group : t -> t

Delimit a group

Sourceval no_group : t -> t

Remove all groups

Sourceval nest : t -> t

when matching against nest e, only the group matching in the last match of e will be considered as matching

Sourceval mark : t -> Mark.t * t

Mark a regexp. the markid can then be used to know if this regexp was used.

Character sets

Sourceval set : string -> t

Any character of the string

Sourceval rg : char -> char -> t

Character ranges

Sourceval inter : t list -> t

Intersection of character sets

Sourceval diff : t -> t -> t

Difference of character sets

Sourceval compl : t list -> t

Complement of union

Predefined character sets

Sourceval any : t

Any character

Sourceval notnl : t

Any character but a newline

Sourceval alnum : t
Sourceval wordc : t
Sourceval alpha : t
Sourceval ascii : t
Sourceval blank : t
Sourceval cntrl : t
Sourceval digit : t
Sourceval graph : t
Sourceval lower : t
Sourceval print : t
Sourceval punct : t
Sourceval space : t
Sourceval upper : t
Sourceval xdigit : t

Case modifiers

Sourceval case : t -> t

Case sensitive matching

Sourceval no_case : t -> t

Case insensitive matching

Internal debugging

Sourceval pp : Format.formatter -> t -> unit
Sourceval pp_re : Format.formatter -> re -> unit
Sourceval print_re : Format.formatter -> re -> unit

Alias for pp_re. Deprecated

Experimental functions

.

Sourceval witness : t -> string

witness r generates a string s such that execp (compile r) s is true

Deprecated functions

Sourcetype substrings = Group.t

Alias for Group.t. Deprecated

Sourceval get : Group.t -> int -> string

Same as Group.get. Deprecated

Sourceval get_ofs : Group.t -> int -> int * int

Same as Group.offset. Deprecated

Sourceval get_all : Group.t -> string array

Same as Group.all. Deprecated

Sourceval get_all_ofs : Group.t -> (int * int) array

Same as Group.all_offset. Deprecated

Sourceval test : Group.t -> int -> bool

Same as Group.test. Deprecated

Sourcetype markid = Mark.t

Alias for Mark.t. Deprecated

Sourceval marked : Group.t -> Mark.t -> bool

Same as Mark.test. Deprecated

Sourceval mark_set : Group.t -> Mark.Set.t

Same as Mark.all. Deprecated

Sourcemodule Emacs : sig ... end

Emacs-style regular expressions

Sourcemodule Glob : sig ... end

Shell-style regular expressions

Sourcemodule Perl : sig ... end

Perl-style regular expressions

Sourcemodule Pcre : sig ... end
Sourcemodule Posix : sig ... end

References:

Sourcemodule Str : sig ... end

Module Str: regular expressions and high-level string processing

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct