Skip to content
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.

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

Add support for ES2025 RegExp duplicate named capturing groups #1291

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion acorn/src/acorn.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -573,7 +573,7 @@ export function tokenizer(input: string, options: Options): {
[Symbol.iterator](): Iterator<Token>
}

export type ecmaVersion = 3 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 2024 | "latest"
export type ecmaVersion = 3 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | "latest"

export interface Options {
/**
Expand Down
35 changes: 35 additions & 0 deletions acorn/src/regexp.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ export class RegExpValidationState {
this.numCapturingParens = 0
this.maxBackReference = 0
this.groupNames = []
this.groupNamesToAddToUpperScope = []
this.backReferenceNames = []
}

Expand Down Expand Up @@ -169,6 +170,7 @@ pp.regexp_pattern = function(state) {
state.numCapturingParens = 0
state.maxBackReference = 0
state.groupNames.length = 0
state.groupNamesToAddToUpperScope.length = 0
state.backReferenceNames.length = 0

this.regexp_disjunction(state)
Expand All @@ -194,11 +196,28 @@ pp.regexp_pattern = function(state) {

// https://www.ecma-international.org/ecma-262/8.0/#prod-Disjunction
pp.regexp_disjunction = function(state) {
let groupNamesToAddToUpperUpperScope
if (this.options.ecmaVersion >= 16) {
groupNamesToAddToUpperUpperScope = state.groupNamesToAddToUpperScope
// Clear groupNamesToAddToUpperScope to store the groupName added in this Disjunction.
state.groupNamesToAddToUpperScope = []
}

this.regexp_alternative(state)
while (state.eat(0x7C /* | */)) {
this.regexp_alternative(state)
}

if (this.options.ecmaVersion >= 16) {
for (const groupName of state.groupNamesToAddToUpperScope) {
// Adds the groupName added in Disjunction to groupNames.
state.groupNames.push(groupName)
// Adds the groupName added in Disjunction to the upper scope.
groupNamesToAddToUpperUpperScope.push(groupName)
}
state.groupNamesToAddToUpperScope = groupNamesToAddToUpperUpperScope
}

// Make the same message as V8.
if (this.regexp_eatQuantifier(state, true)) {
state.raise("Nothing to repeat")
Expand All @@ -210,8 +229,24 @@ pp.regexp_disjunction = function(state) {

// https://www.ecma-international.org/ecma-262/8.0/#prod-Alternative
pp.regexp_alternative = function(state) {
let upperGroupNames
if (this.options.ecmaVersion >= 16) {
upperGroupNames = [...state.groupNames]
}

while (state.pos < state.source.length && this.regexp_eatTerm(state))
;

if (this.options.ecmaVersion >= 16) {
// Adds the groupName added in Alternative to the upper scope.
for (const groupName of state.groupNames) {
if (upperGroupNames.indexOf(groupName) === -1) {
state.groupNamesToAddToUpperScope.push(groupName)
}
}
// Reverts the groupNames so that the next adjacent Alternative does not report duplicates.
state.groupNames = upperGroupNames
}
}

// https://www.ecma-international.org/ecma-262/8.0/#prod-annexB-Term
Expand Down
1 change: 0 additions & 1 deletion bin/test262.unsupported-features
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
decorators
import-assertions
regexp-duplicate-named-groups
1 change: 1 addition & 0 deletions test/run.js
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
require("./tests-regexp-2020.js");
require("./tests-regexp-2022.js");
require("./tests-regexp-2024.js");
require("./tests-regexp-2025.js");
require("./tests-json-superset.js");
require("./tests-optional-catch-binding.js");
require("./tests-bigint.js");
Expand Down
18 changes: 18 additions & 0 deletions test/tests-regexp-2025.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
if (typeof exports !== "undefined") {
var test = require("./driver.js").test
var testFail = require("./driver.js").testFail
}

test("/(?<x>a)|(?<x>b)/", {}, { ecmaVersion: 2025 })
testFail("/(?<x>a)|(?<x>b)/", "Invalid regular expression: /(?<x>a)|(?<x>b)/: Duplicate capture group name (1:1)", { ecmaVersion: 2024 })
testFail("/(?<x>a)(?<x>b)/", "Invalid regular expression: /(?<x>a)(?<x>b)/: Duplicate capture group name (1:1)", { ecmaVersion: 2025 })
test("/(?:(?<x>a)|(?<x>b))\\k<x>/", {}, { ecmaVersion: 2025 })
testFail("/(?:(?<x>a)|(?<x>b))\\k<x>/", "Invalid regular expression: /(?:(?<x>a)|(?<x>b))\\k<x>/: Duplicate capture group name (1:1)", { ecmaVersion: 2024 })
testFail("/(?:(?<x>a)(?<x>b))\\k<x>/", "Invalid regular expression: /(?:(?<x>a)(?<x>b))\\k<x>/: Duplicate capture group name (1:1)", { ecmaVersion: 2025 })
test("/(?<y>a)(?<x>a)|(?<x>b)(?<y>b)/", {}, { ecmaVersion: 2025 })
test("/(?<x>a)|(?<x>b)|(?<x>c)/", {}, { ecmaVersion: 2025 })
test("/(?<x>a)|\\k<x>/", {}, { ecmaVersion: 2025 })
testFail("/(?<x>a)|(?<x>b)(?<x>c)/", "Invalid regular expression: /(?<x>a)|(?<x>b)(?<x>c)/: Duplicate capture group name (1:1)", { ecmaVersion: 2025 })
testFail("/(?:(?<x>a)|(?<x>b))(?<x>c)/", "Invalid regular expression: /(?:(?<x>a)|(?<x>b))(?<x>c)/: Duplicate capture group name (1:1)", { ecmaVersion: 2025 })
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I try it in Safari, it's not a syntax error. I may be misunderstanding something 🤔

Copy link
Contributor Author

@ota-meshi ota-meshi Apr 15, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I try the front and back swapped /(?<x>c)(?:(?<x>a)|(?<x>b))/ in Safari, I will get a syntax error.
Is it a bug in Safari that /(?:(?<x>a)|(?<x>b))(?<x>c)/ does not result in a syntax error? 🤔

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The way I read the spec, yes, that should be a syntax error—there is no | parse node that separates either of the first two definitions of <x> from the last one.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your comment!
I was relieved that my understanding was correct 😄
If the current specs are fine, I think this PR is ready for review.

testFail("/(?<x>a)(?:(?<x>b)|(?<x>c))/", "Invalid regular expression: /(?<x>a)(?:(?<x>b)|(?<x>c))/: Duplicate capture group name (1:1)", { ecmaVersion: 2025 })
testFail("/(?:(?:(?<x>a)|(?<x>b))|(?:))(?<x>c)/", "Invalid regular expression: /(?:(?:(?<x>a)|(?<x>b))|(?:))(?<x>c)/: Duplicate capture group name (1:1)", { ecmaVersion: 2025 })