Replace DynamicCaptures with AnyRegexOutput.
#222
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Rename the `Match` associatedtype in `RegexComponent` to `Output`. - Rename `MatchResult` to `Regex.Match`. The new names have been pitched as part of the [regex type](https://forums.swift.org/t/pitch-regex-type-and-overview/56029) and the [regex builder DSL](https://forums.swift.org/t/pitch-regex-builder-dsl/56007).
`AnyRegexOutput` is a collection type that represents a type-erased regex output with two use cases:
- When a `Regex` is initialized from a string, e.g. `Regex("(a)|(b)|c")`, it has type `Regex<AnyRegexOutput>`. One can iterate over the output to access output elements (the whole match followed by any captures).
- When working with an existing code base that uses dynamic `Regex` creation from strings, one can type-erase the match result of a strongly typed regex, e.g. `Regex<(Substring, Substring, Substring)>.Match`, and use it as a drop in replacement for the dynamic regex match.
This has been pitched as part of the [regex type](https://forums.swift.org/t/pitch-regex-type-and-overview/56029).
---
Example:
```swift
let regex = try! Regex(#"([0-9A-F]+)(?:\.\.([0-9A-F]+))?\s+;\s+(\w+).*"#)
let line = """
A6F0..A6F1 ; Extend # Mn [2] BAMUM COMBINING MARK KOQNDON..BAMUM \
COMBINING MARK TUKWENTIS
"""
let match = line.firstMatch(of: regex)!
let output = match.output // `AnyRegexOutput`
output.0 // => (the entire match)
output[0].bounds // => (the bounds of the entire match)
output[0].substring // => (the entire match)
output[1].substring // => "A6F0"
output[2].substring // => "A6F1"
output[3].substring // => "Extend"
```
|
Please review b5dd0ef as this is on top of another PR. |
|
@swift-ci please test |
milseman
approved these changes
Mar 21, 2022
| fileprivate struct ElementRepresentation { | ||
| /// The depth of `Optioals`s wrapping the underlying value. For example, | ||
| /// `Substring` has optional depth `0`, and `Int??` has optional depth `2`. | ||
| let optionalDepth: Int |
There was a problem hiding this comment.
Unrelated to this PR, did we decide on an optional nesting story?
There was a problem hiding this comment.
There’s no non-factorial solution to optional flattening this year, unfortunately. So we’ll have nested optionals.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
AnyRegexOutputis a collection type that represents a type-erased regex output with two use cases:Regexis initialized from a string, e.g.Regex("(a)|(b)|c"), it has typeRegex<AnyRegexOutput>. One can iterate over the output to access output elements (the whole match followed by any captures).Regexcreation from strings, one can type-erase the match result of a strongly typed regex, e.g.Regex<(Substring, Substring, Substring)>.Match, and use it as a drop in replacement for the dynamic regex match.This has been pitched as part of the regex type.
Example: