Skip to content

Wrong summary for generated regex #114889

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
pawchen opened this issue Apr 22, 2025 · 5 comments · Fixed by #115136
Closed

Wrong summary for generated regex #114889

pawchen opened this issue Apr 22, 2025 · 5 comments · Fixed by #115136
Assignees
@stephentoub
Labels
area-System.Text.RegularExpressions bug

Comments

@pawchen
Copy link

pawchen commented Apr 22, 2025

Description

    [GeneratedRegex(@"\b(ifn?def|endif)?")]
    private static partial Regex MyRegex1 { get; }

The summary generated should state it matches the string if before the optional n, but instead it states Match an empty string.:

Image

I examined the generated matching code and it did look for the 'i' then the 'f', so it appears only the summary was wrong.

Reproduction Steps

    [GeneratedRegex(@"\b(ifn?def|endif)?")]
    private static partial Regex MyRegex1 { get; }

Expected behavior

summary should be stated correctly

Actual behavior

summary was wrong

Regression?

No response

Known Workarounds

Don't look at it?

Configuration

VS 17.13.6
.NET 9

Other information

No response
@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Apr 22, 2025
@dotnet-policy-service Dotnet Policy Service
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-text-regularexpressions
See info in area-owners.md if you want to be subscribed.

@steveharter
Copy link
Contributor

@pawchen can you please open an issue here: https://developercommunity.visualstudio.com/VisualStudio?q=regex

@steveharter steveharter closed this as not planned Won't fix, can't repro, duplicate, stale Apr 25, 2025
@dotnet-policy-service dotnet-policy-service bot removed the untriaged New issue has not been triaged by the area owner label Apr 25, 2025
@pawchen
Copy link
Author

pawchen commented Apr 25, 2025

@steveharter I believe the source code for the generated summary is in this repo.

@huoyaoyuan
Copy link
Member

Yes, the summary is generated by the Regex source generator. /cc @stephentoub

@stephentoub stephentoub reopened this Apr 28, 2025
@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Apr 28, 2025
@stephentoub stephentoub self-assigned this Apr 28, 2025
@stephentoub stephentoub added bug and removed untriaged New issue has not been triaged by the area owner labels Apr 28, 2025
@stephentoub
Copy link
Member

The problem is here:

runtime/src/libraries/System.Text.RegularExpressions/gen/RegexGenerator.Emitter.cs

Lines 1839 to 1849 in 29e3af6

case RegexNodeKind.Concatenate when child.Child(0) == startingLiteralNode && (startingLiteralNode.Kind is RegexNodeKind.One or RegexNodeKind.Set or RegexNodeKind.Multi):
// This is a concatenation where its first node is the starting literal we found and that starting literal
// is one of the nodes above that we know how to handle completely. This is a common
// enough case that we want to special-case it to avoid duplicating the processing for that character
// unnecessarily. So, we'll shave off that first node from the concatenation and then handle the remainder.
// Note that it's critical startingLiteralNode is something we can fully handle above: if it's not,
// we'll end up losing some of the pattern due to overwriting `remainder`.
remainder = child;
child = child.Child(0);
remainder.ReplaceChild(0, new RegexNode(RegexNodeKind.Empty, remainder.Options));
goto HandleChild; // reprocess just the first node that was saved; the remainder will then be processed below

The emitter is mutating the regex node tree, for convenience and under the assumption that after this point no one else will be looking at the tree. But the XML comment generator does.

@stephentoub stephentoub mentioned this issue Apr 29, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stephentoub stephentoub

Labels
area-System.Text.RegularExpressions bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix regex description emitted by generator for switched branches stephentoub/runtime
4 participants
@pawchen @stephentoub @huoyaoyuan @steveharter