Added bracket highlighting for generic angle brackets #8500

TylerDelRosario · 2025-05-11T07:12:38Z

Added bracket highlighting for generic angle brackets.
Includes a couple of new unit tests.

The biggest hurdle is that bit wise shift operators get tokenized by the lexer. The simplest solution would be to take the input TokenHierarchy and split GTGT tokens into separate GT tokens.

But after diving into the lexer module, it seems that almost all token related classes are either immutable or contain package-private constructors. If there's a way that TokenHierarchy can be modified, I would genuinely like to learn how.

Otherwise, I've opted to add an algorithm that specifically handles angle brackets while managing the counter and offsets accordingly.

Thank you to matthiasblaesing for showing where the appropriate files are and the lexer token stream.

^Add meaningful description above

Click to collapse/expand PR instructions

By opening a pull request you confirm that, unless explicitly stated otherwise, the changes -

are all your own work, and you have the right to contribute them.
are contributed solely under the terms and conditions of the Apache License 2.0 (see section 5 of the license for more information).

Please make sure (eg. git log) that all commits have a valid name and email address for you in the Author field.

If you're a first time contributor, see the Contributing guidelines for more information.

If you're a committer, please label the PR before pressing "Create pull request" so that the right test jobs can run.

PR approval and merge checklist:

Was this PR correctly labeled, did the right tests run? When did they run?
Is this PR squashed?
Are author name / email address correct? Are co-authors correctly listed? Do the commit messages need updates?
Does the PR title and description still fit after the Nth iteration? Is the description sufficient to appear in the release notes?

If this PR targets the delivery branch: don't merge. (full wiki article)

… + unit tests

essien · 2025-05-24T12:08:05Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaBracesMatcher.java

@@ -428,7 +520,7 @@ public static List<TokenSequence<?>> getEmbeddedTokenSequences(
        for(int i = sequences.size() - 1; i >= 0; i--) {
            TokenSequence<?> seq = sequences.get(i);
            if (seq.language() == language) {
-                break;
+               break; 


Wrong indentation

matthiasblaesing

Thanks for looking into this. I left a few inline comments, but this needs at least another round. The current state works for simple cases, but fails at others.

I also noticed that comparisons are marked as error:

Bitshifts also look broken:

It might be necessary to create a brace matcher that does not report errors for type braces, but only the matches. Or you'd need to find a marker where to stop scanning.

matthiasblaesing · 2025-05-29T16:47:30Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaBracesMatcher.java

@@ -428,7 +520,7 @@ public static List<TokenSequence<?>> getEmbeddedTokenSequences(
        for(int i = sequences.size() - 1; i >= 0; i--) {
            TokenSequence<?> seq = sequences.get(i);
            if (seq.language() == language) {
-                break;
+               break; 


This change is unnessary and wrong as already indicated by @essien. Please remove.

matthiasblaesing · 2025-05-29T16:47:43Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaBracesMatcher.java

@@ -98,13 +99,13 @@ public int[] findOrigin() throws BadLocationException, InterruptedException {
                context.getLimitOffset(), 
                PAIRS
            );
-
+            


Please remove space at end of lines (see lines 102, 108, 150, 154, 160)

matthiasblaesing · 2025-05-29T18:30:58Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaBracesMatcher.java

+                        if (sq.token().id() == JavaTokenId.GTGTGT) {
+                            if (originId == JavaTokenId.GT) {
+                                if (originOffset != sq.offset()) {
+                                    int test = sq.offset();


stray test code?

matthiasblaesing · 2025-05-29T18:43:17Z

java/java.editor/test/unit/src/org/netbeans/modules/editor/java/JavaBracesMatcherTest.java

+        assertMatches2("Map^<Class<? extends AbstractStudent>,  Map<CourseTime, List<? extends AbstractCourse>>^>");
+        assertMatches2("Map<Class<? extends AbstractStudent>,  Map^<CourseTime, List<? extends AbstractCourse>^>>");
+        assertMatches2("Map x = new HashMap<String, List^<String^>>()");
+    }


This needs more test cases. I added some and hit a bug:

assertMatches2("^<test^>"); assertMatches2("Map^<Class<? extends AbstractStudent>, Map<CourseTime, List<? extends AbstractCourse>>^>"); assertMatches2("Map<Class<? extends AbstractStudent>, Map^<CourseTime, List<? extends AbstractCourse>^>>"); assertMatches2("Map<Class<? extends AbstractStudent>, Map<CourseTime, List^<? extends AbstractCourse^>>>"); assertMatches2("Map<Class^<? extends AbstractStudent^>, Map<CourseTime, List<? extends AbstractCourse>>>"); assertMatches2("Map^<Map<CourseTime, List<? extends AbstractCourse>>, Class<? extends AbstractStudent>^>"); assertMatches2("Map<Map^<CourseTime, List<? extends AbstractCourse>^>, Class<? extends AbstractStudent>>"); assertMatches2("Map<Map<CourseTime, List^<? extends AbstractCourse^>>, Class<? extends AbstractStudent>>"); assertMatches2("Map<Map<CourseTime, List<? extends AbstractCourse>>, Class^<? extends AbstractStudent^>>"); assertMatches2("Map x = new HashMap<String, List^<String^>>()"); assertMatches2("Map x = new HashMap^<String, List<String>^>()");

May I also add that <> should match in the below:

class LinkedList < T extends Object & Serializable > { }

but <> should not match in the below:

int Object = 2; int Serializable = 3; boolean result = 1 < Object & Serializable > 4;

Yeah, there needs to be some way to differentiate generic brackets from comparison/operator brackets.

matthiasblaesing · 2025-05-29T18:48:32Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaBracesMatcher.java

+                /* One idea was to modify the input TokenHierachy to split
+                ** GTGT tokens into 2 separate GT and GT tokens. However,
+                ** it seems like almost all token related classes are immutable
+                ** or inaccessible due to private constructors. Leading me to
+                ** write this. */


The TokenHierarchy/-sequence represents the lexing result and yes, for analysis they are read-only. This comment gives reasoning for the current implementation, but reads more like "note to self", then intentional for others.

matthiasblaesing · 2025-05-29T18:55:48Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaBracesMatcher.java

+                                }
+                            }
+
+                            //Shouldn't happen, but added it anyways.


I assume that this refers to the fact, that after each opening brace a type must be placed? I mean List<TYPE?

matthiasblaesing · 2025-05-29T19:00:36Z

java/java.editor/src/org/netbeans/modules/editor/java/JavaBracesMatcher.java

+                        if (sq.token().id() == JavaTokenId.GTGT) {
+                            if (originId == JavaTokenId.GT) {
+                                if (originOffset != sq.offset()) {
+                                    counter += (originOffset - sq.offset());


I don't understand the idea here. Why is the originOffset used here? Shouldn't count just count the number of unmatched braces?

TylerDelRosario · 2025-05-31T01:01:12Z

Thank you for taking your time to build and review this. I genuinely appreciate the feedback.
I'm going add these unit tests and give this another round to specifically address the comparison and bitwise error markers while making my code more readable. I'll also fix the formatting errors that you and essien pointed out.

[NETBEANS-5024] Added bracket highlighting for generic angle brackets…

f83cb61

… + unit tests

essien reviewed May 24, 2025

View reviewed changes

matthiasblaesing reviewed May 29, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Added bracket highlighting for generic angle brackets #8500

Added bracket highlighting for generic angle brackets #8500

Uh oh!

TylerDelRosario commented May 11, 2025 •

edited

Loading

Uh oh!

essien May 24, 2025

Uh oh!

matthiasblaesing left a comment

Uh oh!

matthiasblaesing May 29, 2025

Uh oh!

matthiasblaesing May 29, 2025

Uh oh!

matthiasblaesing May 29, 2025

Uh oh!

matthiasblaesing May 29, 2025

Uh oh!

essien May 31, 2025

Uh oh!

TylerDelRosario Jun 2, 2025

Uh oh!

matthiasblaesing May 29, 2025

Uh oh!

matthiasblaesing May 29, 2025

Uh oh!

matthiasblaesing May 29, 2025

Uh oh!

TylerDelRosario commented May 31, 2025

Uh oh!

Uh oh!

Added bracket highlighting for generic angle brackets #8500

Are you sure you want to change the base?

Added bracket highlighting for generic angle brackets #8500

Uh oh!

Conversation

TylerDelRosario commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR approval and merge checklist:

Uh oh!

Choose a reason for hiding this comment

Uh oh!

matthiasblaesing left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TylerDelRosario commented May 31, 2025

Uh oh!

Uh oh!

TylerDelRosario commented May 11, 2025 •

edited

Loading