Skip to content

Commit 32afc43

Browse files
natecook1000natecook1000
authored
Make the Regex type Sendable (#457)
This change makes `Regex`, `RegexComponent`, and its component types `Sendable`. Regex stores a `Program` instance, which lazily lowers the DSLTree into a compiled program. Without synchronization, this lazy compilation is unsafe under concurrency. This change uses atomic initialization for the compiled program.
1 parent a149466 commit 32afc43

File tree

14 files changed

+150
-101
lines changed

14 files changed

+150
-101
lines changed

‎Package.swift‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,10 @@ let package = Package(
6262
dependencies: []),
6363
.target(
6464
name: "_StringProcessing",
65-
dependencies: ["_RegexParser", "_CUnicode"],
65+
dependencies: [
66+
"_RegexParser",
67+
"_CUnicode",
68+
],
6669
swiftSettings: publicStdlibSettings),
6770
.target(
6871
name: "RegexBuilder",

‎Sources/_RegexParser/Regex/AST/AST.swift‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ extension AST {
3030
extension AST {
3131
/// A node in the regex AST.
3232
public indirect enum Node:
33-
Hashable, _TreeNode //, _ASTPrintable ASTValue, ASTAction
33+
Hashable, _TreeNode, Sendable //, _ASTPrintable ASTValue, ASTAction
3434
{
3535
/// ... | ... | ...
3636
case alternation(Alternation)
@@ -143,7 +143,7 @@ extension AST.Node {
143143

144144
extension AST {
145145

146-
public struct Alternation: Hashable, _ASTNode {
146+
public struct Alternation: Hashable, Sendable, _ASTNode {
147147
public let children: [AST.Node]
148148
public let pipes: [SourceLocation]
149149

@@ -162,7 +162,7 @@ extension AST {
162162
}
163163
}
164164

165-
public struct Concatenation: Hashable, _ASTNode {
165+
public struct Concatenation: Hashable, Sendable, _ASTNode {
166166
public let children: [AST.Node]
167167
public let location: SourceLocation
168168

@@ -172,7 +172,7 @@ extension AST {
172172
}
173173
}
174174

175-
public struct Quote: Hashable, _ASTNode {
175+
public struct Quote: Hashable, Sendable, _ASTNode {
176176
public let literal: String
177177
public let location: SourceLocation
178178

@@ -182,7 +182,7 @@ extension AST {
182182
}
183183
}
184184

185-
public struct Trivia: Hashable, _ASTNode {
185+
public struct Trivia: Hashable, Sendable, _ASTNode {
186186
public let contents: String
187187
public let location: SourceLocation
188188

@@ -197,7 +197,7 @@ extension AST {
197197
}
198198
}
199199

200-
public struct Interpolation: Hashable, _ASTNode {
200+
public struct Interpolation: Hashable, Sendable, _ASTNode {
201201
public let contents: String
202202
public let location: SourceLocation
203203

@@ -207,7 +207,7 @@ extension AST {
207207
}
208208
}
209209

210-
public struct Empty: Hashable, _ASTNode {
210+
public struct Empty: Hashable, Sendable, _ASTNode {
211211
public let location: SourceLocation
212212

213213
public init(_ location: SourceLocation) {
@@ -219,15 +219,15 @@ extension AST {
219219
///
220220
/// This is used to model a pattern which should
221221
/// not be matched against across varying scopes.
222-
public struct AbsentFunction: Hashable, _ASTNode {
223-
public enum Start: Hashable {
222+
public struct AbsentFunction: Hashable, Sendable, _ASTNode {
223+
public enum Start: Hashable, Sendable {
224224
/// `(?~|`
225225
case withPipe
226226

227227
/// `(?~`
228228
case withoutPipe
229229
}
230-
public enum Kind: Hashable {
230+
public enum Kind: Hashable, Sendable {
231231
/// An absent repeater `(?~absent)`. This is equivalent to `(?~|absent|.*)`
232232
/// and therefore matches as long as the pattern `absent` is not matched.
233233
case repeater(AST.Node)
@@ -261,8 +261,8 @@ extension AST {
261261
}
262262
}
263263

264-
public struct Reference: Hashable {
265-
public enum Kind: Hashable {
264+
public struct Reference: Hashable, Sendable {
265+
public enum Kind: Hashable, Sendable {
266266
// \n \gn \g{n} \g<n> \g'n' (?n) (?(n)...
267267
// Oniguruma: \k<n>, \k'n'
268268
case absolute(Int)
@@ -304,7 +304,7 @@ extension AST {
304304
}
305305

306306
/// A set of global matching options in a regular expression literal.
307-
public struct GlobalMatchingOptionSequence: Hashable {
307+
public struct GlobalMatchingOptionSequence: Hashable, Sendable {
308308
public var options: [AST.GlobalMatchingOption]
309309

310310
public init?(_ options: [AST.GlobalMatchingOption]) {

‎Sources/_RegexParser/Regex/AST/Atom.swift‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//===----------------------------------------------------------------------===//
1111

1212
extension AST {
13-
public struct Atom: Hashable, _ASTNode {
13+
public struct Atom: Hashable, Sendable, _ASTNode {
1414
public let kind: Kind
1515
public let location: SourceLocation
1616

@@ -19,7 +19,7 @@ extension AST {
1919
self.location = loc
2020
}
2121

22-
public enum Kind: Hashable {
22+
public enum Kind: Hashable, Sendable {
2323
/// Just a character
2424
///
2525
/// A, \*, \\, ...
@@ -113,7 +113,7 @@ extension AST.Atom {
113113
}
114114

115115
extension AST.Atom {
116-
public struct Scalar: Hashable {
116+
public struct Scalar: Hashable, Sendable {
117117
public var value: UnicodeScalar
118118
public var location: SourceLocation
119119

@@ -123,7 +123,7 @@ extension AST.Atom {
123123
}
124124
}
125125

126-
public struct ScalarSequence: Hashable {
126+
public struct ScalarSequence: Hashable, Sendable {
127127
public var scalars: [Scalar]
128128
public var trivia: [AST.Trivia]
129129

@@ -145,7 +145,7 @@ extension AST.Atom {
145145

146146
// Characters, character types, literals, etc., derived from
147147
// an escape sequence.
148-
public enum EscapedBuiltin: Hashable {
148+
public enum EscapedBuiltin: Hashable, Sendable {
149149
// TODO: better doc comments
150150

151151
// Literal single characters
@@ -374,7 +374,7 @@ extension AST.Atom.EscapedBuiltin {
374374
}
375375

376376
extension AST.Atom {
377-
public struct CharacterProperty: Hashable {
377+
public struct CharacterProperty: Hashable, Sendable {
378378
public var kind: Kind
379379

380380
/// Whether this is an inverted property e.g '\P{Ll}', '[:^ascii:]'.
@@ -397,7 +397,7 @@ extension AST.Atom {
397397
}
398398

399399
extension AST.Atom.CharacterProperty {
400-
public enum Kind: Hashable {
400+
public enum Kind: Hashable, Sendable {
401401
/// Matches any character, equivalent to Oniguruma's '\O'.
402402
case any
403403

@@ -453,14 +453,14 @@ extension AST.Atom.CharacterProperty {
453453
/// Some special properties implemented by Java.
454454
case javaSpecial(JavaSpecial)
455455

456-
public enum MapKind: Hashable {
456+
public enum MapKind: Hashable, Sendable {
457457
case lowercase
458458
case uppercase
459459
case titlecase
460460
}
461461
}
462462

463-
public enum PCRESpecialCategory: String, Hashable {
463+
public enum PCRESpecialCategory: String, Hashable, Sendable {
464464
case alphanumeric = "Xan"
465465
case posixSpace = "Xps"
466466
case perlSpace = "Xsp"
@@ -470,7 +470,7 @@ extension AST.Atom.CharacterProperty {
470470

471471
/// Special Java properties that correspond to methods on
472472
/// `java.lang.Character`, with the `java` prefix replaced by `is`.
473-
public enum JavaSpecial: String, Hashable, CaseIterable {
473+
public enum JavaSpecial: String, Hashable, CaseIterable, Sendable {
474474
case alphabetic = "javaAlphabetic"
475475
case defined = "javaDefined"
476476
case digit = "javaDigit"
@@ -494,7 +494,7 @@ extension AST.Atom.CharacterProperty {
494494

495495
extension AST.Atom {
496496
/// Anchors and other built-in zero-width assertions.
497-
public enum AssertionKind: String {
497+
public enum AssertionKind: String, Hashable, Sendable {
498498
/// \A
499499
case startOfSubject = #"\A"#
500500

@@ -554,10 +554,10 @@ extension AST.Atom {
554554
}
555555

556556
extension AST.Atom {
557-
public enum Callout: Hashable {
557+
public enum Callout: Hashable, Sendable {
558558
/// A PCRE callout written `(?C...)`
559-
public struct PCRE: Hashable {
560-
public enum Argument: Hashable {
559+
public struct PCRE: Hashable, Sendable {
560+
public enum Argument: Hashable, Sendable {
561561
case number(Int)
562562
case string(String)
563563
}
@@ -573,8 +573,8 @@ extension AST.Atom {
573573
}
574574

575575
/// A named Oniguruma callout written `(*name[tag]{args, ...})`
576-
public struct OnigurumaNamed: Hashable {
577-
public struct ArgList: Hashable {
576+
public struct OnigurumaNamed: Hashable, Sendable {
577+
public struct ArgList: Hashable, Sendable {
578578
public var leftBrace: SourceLocation
579579
public var args: [AST.Located<String>]
580580
public var rightBrace: SourceLocation
@@ -604,8 +604,8 @@ extension AST.Atom {
604604
}
605605

606606
/// An Oniguruma callout 'of contents', written `(?{...}[tag]D)`
607-
public struct OnigurumaOfContents: Hashable {
608-
public enum Direction: Hashable {
607+
public struct OnigurumaOfContents: Hashable, Sendable {
608+
public enum Direction: Hashable, Sendable {
609609
case inProgress // > (the default)
610610
case inRetraction // <
611611
case both // X
@@ -652,7 +652,7 @@ extension AST.Atom {
652652

653653
extension AST.Atom.Callout {
654654
/// A tag specifier `[...]` that can appear in an Oniguruma callout.
655-
public struct OnigurumaTag: Hashable {
655+
public struct OnigurumaTag: Hashable, Sendable {
656656
public var leftBracket: SourceLocation
657657
public var name: AST.Located<String>
658658
public var rightBracket: SourceLocation
@@ -670,8 +670,8 @@ extension AST.Atom.Callout {
670670
}
671671

672672
extension AST.Atom {
673-
public struct BacktrackingDirective: Hashable {
674-
public enum Kind: Hashable {
673+
public struct BacktrackingDirective: Hashable, Sendable {
674+
public enum Kind: Hashable, Sendable {
675675
/// (*ACCEPT)
676676
case accept
677677

‎Sources/_RegexParser/Regex/AST/Conditional.swift‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//===----------------------------------------------------------------------===//
1111

1212
extension AST {
13-
public struct Conditional: Hashable, _ASTNode {
13+
public struct Conditional: Hashable, Sendable, _ASTNode {
1414
public var location: SourceLocation
1515
public var condition: Condition
1616

@@ -32,8 +32,8 @@ extension AST {
3232
}
3333

3434
extension AST.Conditional {
35-
public struct Condition: Hashable {
36-
public enum Kind: Hashable {
35+
public struct Condition: Hashable, Sendable {
36+
public enum Kind: Hashable, Sendable {
3737
/// Check to see if a certain group was matched.
3838
case groupMatched(AST.Reference)
3939

@@ -65,7 +65,7 @@ extension AST.Conditional {
6565
}
6666

6767
extension AST.Conditional.Condition {
68-
public struct PCREVersionNumber: Hashable {
68+
public struct PCREVersionNumber: Hashable, Sendable {
6969
public var major: Int
7070
public var minor: Int
7171
public var location: SourceLocation
@@ -76,8 +76,8 @@ extension AST.Conditional.Condition {
7676
self.location = location
7777
}
7878
}
79-
public struct PCREVersionCheck: Hashable {
80-
public enum Kind: Hashable {
79+
public struct PCREVersionCheck: Hashable, Sendable {
80+
public enum Kind: Hashable, Sendable {
8181
case equal, greaterThanOrEqual
8282
}
8383
public var kind: AST.Located<Kind>

‎Sources/_RegexParser/Regex/AST/CustomCharClass.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

1212

1313
extension AST {
14-
public struct CustomCharacterClass: Hashable {
14+
public struct CustomCharacterClass: Hashable, Sendable {
1515
public var start: Located<Start>
1616
public var members: [Member]
1717

@@ -27,7 +27,7 @@ extension AST {
2727
self.location = sr
2828
}
2929

30-
public enum Member: Hashable {
30+
public enum Member: Hashable, Sendable {
3131
/// A nested custom character class `[[ab][cd]]`
3232
case custom(CustomCharacterClass)
3333

@@ -47,7 +47,7 @@ extension AST {
4747
/// A binary operator applied to sets of members `abc&&def`
4848
case setOperation([Member], Located<SetOp>, [Member])
4949
}
50-
public struct Range: Hashable {
50+
public struct Range: Hashable, Sendable {
5151
public var lhs: Atom
5252
public var dashLoc: SourceLocation
5353
public var rhs: Atom
@@ -63,12 +63,12 @@ extension AST {
6363
self.trivia = trivia
6464
}
6565
}
66-
public enum SetOp: String, Hashable {
66+
public enum SetOp: String, Hashable, Sendable {
6767
case subtraction = "--"
6868
case intersection = "&&"
6969
case symmetricDifference = "~~"
7070
}
71-
public enum Start: String {
71+
public enum Start: String, Hashable, Sendable {
7272
case normal = "["
7373
case inverted = "[^"
7474
}

‎Sources/_RegexParser/Regex/AST/Group.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
//===----------------------------------------------------------------------===//
1111

1212
extension AST {
13-
public struct Group: Hashable {
13+
public struct Group: Hashable, Sendable {
1414
public let kind: Located<Kind>
1515
public let child: AST.Node
1616

@@ -24,7 +24,7 @@ extension AST {
2424
self.location = r
2525
}
2626

27-
public enum Kind: Hashable {
27+
public enum Kind: Hashable, Sendable {
2828
// (...)
2929
case capture
3030

@@ -116,7 +116,7 @@ extension AST.Group.Kind {
116116
}
117117

118118
extension AST.Group {
119-
public struct BalancedCapture: Hashable {
119+
public struct BalancedCapture: Hashable, Sendable {
120120
/// The name of the group, or nil if the group has no name.
121121
public var name: AST.Located<String>?
122122

0 commit comments

Comments
 (0)