[Feature Request] Bracket Pair Colorization: Allow bracket pairs to share open tokens or close tokens

[roccomao]

The editor now supports native bracket pair colorization, but the languages where multiple bracket pairs share the same open token or close token are not correctly supported. This is a legacy issue from Bracket Pair Colorization (ref issue #301). DragWx has submitted a solution, ref PR #310, but the author(CoenraadS) has not reviewed and merged the code for a long time.

Actually, when setting "editor.bracketPairColorization.enabled": true to enable Bracket pair colorization, there will be some languages that can not be properly supported. So hopefully the developers can support this feature (#310).

It's also worth mentioning that the bracket matching of vscode works correctly, but the colorization is incorrect, as shown below:

PS: Here are some examples of languages that share open tokens or close tokens.

Verilog/SystemVerilog brackets examples:

[ case  , endcase ]
[ casex , endcase ]
[ casez , endcase ]

AL Language brackets examples:

[ case  , end; ]
[ begin , end; ]

LaTeX brackets examples:

[ \left( , \right) ]
[ \left( , \right. ]
[ \left. , \right) ]

PPS: @CoenraadS, In Bracket Pair Colorization, there are already many related issues: #301, #170, #416, #328, #332, #371, #349 (some are duplicates).

[hediet]

Thanks for reporting this!

I did not think of this case.
But I guess this can be easily fixed here:
A closing bracket token is assumed to close an opening bracket token if and only if they have equal category-numbers.
I guess in case of verilog, case, casex and casez should all have the same category (currently they have different ones).

If someone wants to contribute a PR, please ping me!

[DragWx]

Hey @hediet, I've got a solution maybe 80% of the way there, once I add some tests and clean up, it'll be ready.

One thing though, the line tokenizer always seems to split tokens at backslashes \, and that interferes with LaTeX's \left\{ and \right\} brackets. The fast parser grabs these without any issues, but the moment the normal token-based parser is invoked, it's impossible to get these to match. I'm pretty certain this is a tokenizing issue and not a bracket-sharing issue, so I'm going to leave it alone so I can button everything else up.

The issues in Verilog and LaTeX which were related to bracket sharing, I think I've got those squared away, and I'll get a PR up tonight or tomorrow.

[hediet]

Implemented by #132504.

[rchiodo]

I'm not sure but I don't think this is working.

I have the following set:

    "editor.bracketPairColorization.enabled": true,
    "editor.guides.bracketPairs": true,
    "workbench.colorCustomizations": {
        "[Default Light+]": {
            "editorBracketMatch.background": "#ff0000"
        }
    }

Which in a cpp file produces the following:

But I don't get similar results in a latex file:

Perhaps I need to install something else for it to work?

[rchiodo]

It does seem to work for verilog cases though:

[hediet]

It only shows scope lines for multi-line bracket pairs. Your LaTeX example does not have those.

[rchiodo]

Your LaTeX example does not have those.

@hediet I thought these were multiline bracket pairs?

\begin{document}
...
\end{document}

[rzhao271]

Marking as verified for now. I think for LaTeX, the idea is to identify \left\{ and \right\} as a bracket pair, whereas for something like \begin{document}, the bracket pair is just the { and }.

Example:

\begin{equation}
	\left\{2+2+3\right\}
\end{equation}