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
124
125
126
127
128
|
//// 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:
///
/// - match — the full string of the match.
/// - index — the index of the match in the original string.
/// - number — each match is numbered, starting from 1
/// - submatches — a Regex can have subpatterns, sup-parts that are in parentheses.
///
pub type Match {
Match(
match: String,
index: Int,
number: Int,
submatches: List(Option(String)),
)
}
/// When a regular expression fails to compile:
///
/// - error — a descriptive error message
/// - index — the index of the cause in the regex string
///
pub type FromStringError {
FromStringError(error: String, index: Int)
}
/// Create a new Regex.
///
/// ## Examples
///
/// > assert Ok(re) = from_string("[0-9]")
/// > match(re, "abc123")
/// True
///
/// > match(re, "abcxyz")
/// False
///
/// > from_string("[0-9")
/// Error(
/// FromStringError(
/// error: "missing terminating ] for character class",
/// index: 4
/// )
/// )
///
pub external fn from_string(String) -> Result(Regex, FromStringError) =
"gleam_stdlib" "regex_from_string"
pub type Options {
Options(case_insensitive: Bool, multi_line: Bool)
}
/// Create a Regex with some additional options.
///
/// ## Examples
///
/// > let options = Options(case_insensitive: False, multi_line: True)
/// > assert Ok(re) = from_string_with(options, "^[0-9]")
/// > match(re, "abc\n123")
/// True
///
/// > let options = Options(case_insensitive: True, multi_line: False)
/// > assert Ok(re) = from_string_with(options, "[A-Z]")
/// > match(re, "abc123")
/// True
///
pub external fn from_string_with(
Options,
String,
) -> Result(Regex, FromStringError) =
"gleam_stdlib" "regex_from_string_with"
/// Returns a boolean indicating whether there was a match or not.
///
/// ## Examples
///
/// > assert Ok(re) = from_string("^f.o.?")
/// > match(re, "foo")
/// True
///
/// > match(re, "boo")
/// False
///
pub external fn match(Regex, String) -> Bool =
"gleam_stdlib" "regex_match"
/// Split a string
///
/// ## Examples
///
/// > assert Ok(re) = from_string(" *, *")
/// > split(re, "foo,32, 4, 9 ,0")
/// ["foo", "32", "4", "9", "0"]
///
pub external fn split(Regex, 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(re, "I am on a boat in a lake.")
/// [
/// Match(
/// match: "on a boat",
/// index: 5,
/// number: 1,
/// submatches: [Some("boat")]
/// ),
/// Match(
/// match: "in a lake",
/// index: 15,
/// number: 2,
/// submatches: [Some("lake")]
/// )
/// ]
///
pub external fn scan(Regex, String) -> List(Match) =
"gleam_stdlib" "regex_scan"
|
