Nim wrapper around PCRE -- UNMAINATINED, now in stdlib
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
src Update docs Jun 1, 2015
test Change to options module May 26, 2015
web Add logo Jan 21, 2015
.gitignore Initial Commit Jan 7, 2015
LICENCE Add licence Jan 18, 2015
README.rst Update README.rst May 13, 2016
circle.yml Add CircleCI Apr 9, 2015
nre.nimble Bump version number May 26, 2015 Remove unnecessary filter Feb 7, 2015



Use nre from the stdlib

What is NRE?

A regular expression library for Nim using PCRE to do the hard work.


The re.nim module that Nim provides in its standard library is inadequate:

  • It provides only a limited number of captures, while the underling library (PCRE) allows an unlimited number.
  • Instead of having one proc that returns both the bounds and substring, it has one for the bounds and another for the substring.
  • If the splitting regex is empty (""), then it returns the input string instead of following Perl, Javascript, and Java's precedent of returning a list of each character ("123".split(re"") == @["1", "2", "3"]).

Other Notes

By default, NRE compiles it’s own PCRE. If this is undesirable, pass -d:pcreDynlib to use whatever dynamic library is available on the system. This may have unexpected consequences if the dynamic library doesn’t have certain features enabled. Types -----

type Regex* = ref object

Represents the pattern that things are matched against, constructed with re(string). Examples: re"foo", re(r"(*ANYCRLF)(?x)foo # comment".

pattern: string
the string that was used to create the pattern.
captureCount: int
the number of captures that the pattern has.
captureNameId: Table[string, int]
a table from the capture names to their numeric id.

The following options may appear anywhere in the pattern, and they affect the rest of it.

  • (?i) - case insensitive
  • (?m) - multi-line: ^ and $ match the beginning and end of lines, not of the subject string
  • (?s) - . also matches newline (dotall)
  • (?U) - expressions are not greedy by default. ? can be added to a qualifier to make it greedy
  • (?x) - whitespace and comments (#) are ignored (extended)
  • (?X) - character escapes without special meaning (\w vs. \a) are errors (extra)

One or a combination of these options may appear only at the beginning of the pattern:

  • (*UTF8) - treat both the pattern and subject as UTF-8

  • (*UCP) - Unicode character properties; \w matches я

  • (*U) - a combination of the two options above

  • (*FIRSTLINE*) - fails if there is not a match on the first line

  • (*NO_AUTO_CAPTURE) - turn off auto-capture for groups; (?<name>...) can be used to capture

  • (*CR) - newlines are separated by \r

  • (*LF) - newlines are separated by \n (UNIX default)

  • (*CRLF) - newlines are separated by \r\n (Windows default)

  • (*ANYCRLF) - newlines are separated by any of the above

  • (*ANY) - newlines are separated by any of the above and Unicode newlines:

    single characters VT (vertical tab, U+000B), FF (form feed, U+000C), NEL (next line, U+0085), LS (line separator, U+2028), and PS (paragraph separator, U+2029). For the 8-bit library, the last two are recognized only in UTF-8 mode. — man pcre

  • (*JAVASCRIPT_COMPAT) - JavaScript compatibility

  • (*NO_STUDY) - turn off studying; study is enabled by default

For more details on the leading option groups, see the Option Setting and the Newline Convention sections of the PCRE syntax manual.

type RegexMatch* = object

Usually seen as Option[RegexMatch], it represents the result of an execution. On failure, it is none, on success, it is some.

pattern: Regex
the pattern that is being matched
str: string
the string that was matched against
captures[]: string

the string value of whatever was captured at that id. If the value is invalid, then behavior is undefined. If the id is -1, then the whole match is returned. If the given capture was not matched, nil is returned.

  • "abc".match(re"(\w)").get.captures[0] == "a"
  • "abc".match(re"(?<letter>\w)").get.captures["letter"] == "a"
  • "abc".match(re"(\w)\w").get.captures[-1] == "ab"
captureBounds[]: Option[Slice[int]]

gets the bounds of the given capture according to the same rules as the above. If the capture is not filled, then None is returned. The bounds are both inclusive.

  • "abc".match(re"(\w)").get.captureBounds[0] == 0 .. 0
  • "abc".match(re"").get.captureBounds[-1] == 0 .. -1
  • "abc".match(re"abc").get.captureBounds[-1] == 0 .. 2
match: string
the full text of the match.
matchBounds: Slice[int]
the bounds of the match, as in captureBounds[]
returns a table with each named capture as a key.
returns all the captures by their number.
$: string
same as match

type RegexInternalError* = ref object of RegexException

Internal error in the module, this probably means that there is a bug

type InvalidUnicodeError* = ref object of RegexException

Thrown when matching fails due to invalid unicode in strings

type SyntaxError* = ref object of RegexException

Thrown when there is a syntax error in the regular expression string passed in

type StudyError* = ref object of RegexException

Thrown when studying the regular expression failes for whatever reason. The message contains the error code.


proc match*(str: string, pattern: Regex, start = 0, endpos = int.high): Option[RegexMatch]

Like `find(...) <#proc-find>`__, but anchored to the start of the string. This means that "foo".match(re"f").isSome == true, but "foo".match(re"o").isSome == false.

iterator findIter*(str: string, pattern: Regex, start = 0, endpos = int.high): RegexMatch

Works the same as `find(...) <#proc-find>`__, but finds every non-overlapping match. "2222".findIter(re"22") is "22", "22", not "22", "22", "22".

Arguments are the same as `find(...) <#proc-find>`__


  • proc findAll(...) returns a seq[string]

proc find*(str: string, pattern: Regex, start = 0, endpos = int.high): Option[RegexMatch]

Finds the given pattern in the string between the end and start positions.

The start point at which to start matching. |abc is 0; a|bc is 1
The maximum index for a match; int.high means the end of the string, otherwise it’s an inclusive upper bound.

proc split*(str: string, pattern: Regex, maxSplit = -1, start = 0): seq[string]

Splits the string with the given regex. This works according to the rules that Perl and Javascript use:

  • If the match is zero-width, then the string is still split: "123".split(r"") == @["1", "2", "3"].
  • If the pattern has a capture in it, it is added after the string split: "12".split(re"(\d)") == @["", "1", "", "2", ""].
  • If maxsplit != -1, then the string will only be split maxsplit - 1 times. This means that there will be maxsplit strings in the output seq. "1.2.3".split(re"\.", maxsplit = 2) == @["1", "2.3"]

start behaves the same as in `find(...) <#proc-find>`__.

proc replace*(str: string, pattern: Regex, subproc: proc (match: RegexMatch): string): string

Replaces each match of Regex in the string with sub, which should never be or return nil.

If sub is a proc (RegexMatch): string, then it is executed with each match and the return value is the replacement value.

If sub is a proc (string): string, then it is executed with the full text of the match and and the return value is the replacement value.

If sub is a string, the syntax is as follows:

  • $$ - literal $
  • $123 - capture number 123
  • $foo - named capture foo
  • ${foo} - same as above
  • $1$# - first and second captures
  • $# - first capture
  • $0 - full match

If a given capture is missing, a ValueError exception is thrown.

proc escapeRe*(str: string): string

Escapes the string so it doesn’t match any special characters. Incompatible with the Extra flag (X).