1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
//// This module contains regular expression matching functions for strings.
//// The matching algorithms of the library are based on the PCRE library, but not
//// all of the PCRE library is interfaced and some parts of the library go beyond
//// what PCRE offers. Currently PCRE version 8.40 (release date 2017-01-11) is used.
import gleam/option.{Option}
pub external type Regex
/// The details about a particular match:
///
pub type Match {
Match(
/// The full string of the match.
content: String,
/// The byte index of the match in the original string.
byte_index: Int,
/// A Regex can have subpatterns, sup-parts that are in parentheses.
submatches: List(Option(String)),
)
}
/// When a regular expression fails to compile:
///
pub type CompileError {
CompileError(
/// The problem encountered that caused the compilation to fail
error: String,
/// The byte index into the string to where the problem was found
byte_index: Int,
)
}
pub type Options {
Options(case_insensitive: Bool, multi_line: Bool)
}
/// Creates a Regex with some additional options.
///
/// ## Examples
///
/// > let options = Options(case_insensitive: False, multi_line: True)
/// > assert Ok(re) = compile("^[0-9]", with: options)
/// > match(re, "abc\n123")
/// True
///
/// > let options = Options(case_insensitive: True, multi_line: False)
/// > assert Ok(re) = compile("[A-Z]", with: options)
/// > match(re, "abc123")
/// True
///
pub external fn compile(String, with: Options) -> Result(Regex, CompileError) =
"gleam_stdlib" "compile_regex"
/// Creates a new Regex.
///
/// ## Examples
///
/// > assert Ok(re) = from_string("[0-9]")
/// > match(re, "abc123")
/// True
///
/// > match(re, "abcxyz")
/// False
///
/// > from_string("[0-9")
/// Error(
/// CompileError(
/// error: "missing terminating ] for character class",
/// byte_index: 4
/// )
/// )
///
pub fn from_string(pattern: String) -> Result(Regex, CompileError) {
compile(pattern, Options(case_insensitive: False, multi_line: False))
}
/// Returns a boolean indicating whether there was a match or not.
///
/// ## Examples
///
/// > assert Ok(re) = from_string("^f.o.?")
/// > check(with: re, content: "foo")
/// True
///
/// > check(with: re, content: "boo")
/// False
///
pub external fn check(with: Regex, content: String) -> Bool =
"gleam_stdlib" "regex_match"
/// Splits a string
///
/// ## Examples
///
/// > assert Ok(re) = from_string(" *, *")
/// > split(with: re, content: "foo,32, 4, 9 ,0")
/// ["foo", "32", "4", "9", "0"]
///
pub external fn split(with: Regex, content: String) -> List(String) =
"gleam_stdlib" "regex_split"
/// Collects all matches of the regular expression.
///
/// ## Examples
///
/// > assert Ok(re) = regex.from_string("[oi]n a (\\w+)")
/// > regex.scan(with: re, content: "I am on a boat in a lake.")
/// [
/// Match(
/// content: "on a boat",
/// byte_index: 5,
/// submatches: [Some("boat")]
/// ),
/// Match(
/// content: "in a lake",
/// byte_index: 15,
/// submatches: [Some("lake")]
/// )
/// ]
///
pub external fn scan(with: Regex, content: String) -> List(Match) =
"gleam_stdlib" "regex_scan"
|
