Show ZWSP (zero with space) as code mining by marcushoepfner · Pull Request #1437 · eclipse-platform/eclipse.platform.ui

marcushoepfner · 2023-12-19T15:41:38Z

For more information refer to https://www.compart.com/en/unicode/U+200B To get a ZWSP refer to https://zerowidthspace.me/

...r/src/org/eclipse/ui/internal/texteditor/codemining/ZeroWidthSpaceLineContentCodeMining.java

github-actions · 2023-12-19T16:20:22Z

Test Results

0 files - 3 024 0 suites - 3 024 0s ⏱️ - 2h 21m 12s
0 tests - 8 232 0 ✅ - 7 984 0 💤 - 248 0 ❌ ±0
0 runs - 23 520 0 ✅ - 22 729 0 💤 - 791 0 ❌ ±0

Results for commit b81cb31. ± Comparison against base commit de0e232.

♻️ This comment has been updated with latest results.

BeckerWdf · 2023-12-20T07:34:19Z

I did a quick manual test on macOS. I found the following issues:

code mining is not displayed emidiately. I have to close and reopen the editor for the code minings to be shown
Two ZWSP next to each other are drawn one the (almost?) same location. See line 4 in:

When select the "a" and the "ZWSP" in line 2 from the above screenshot to with the keyboard I have to press the right-cursor two times until the caret is behind the "ZWSP".

...g/eclipse/ui/internal/texteditor/codemining/ZeroWidthSpaceLineContentCodeMiningProvider.java

BeckerWdf · 2025-08-13T07:42:34Z

I manually tested your change.

the ZWSP is shown correctly:

but when I disable the "show whitespace character" function (e.g. via the toolbar button) the ZWSP code mining still not disappears (even though the other "white space character" stuff does correctly disappear:

BeckerWdf

See my comments above

BeckerWdf · 2025-08-13T07:46:36Z

another topic:
a user can change the color of the code minings in the "fonts and colors" preference page. If you do this you will see a mix of colors:

Maybe this can be improved:

either by ignoring the users color pref here
also use the code mining color from preferences for the other "white space character" drawing logic.

marcushoepfner · 2025-10-09T13:05:17Z

I manually tested your change.

the ZWSP is shown correctly:

but when I disable the "show whitespace character" function (e.g. via the toolbar button) the ZWSP code mining still not disappears (even though the other "white space character" stuff does correctly disappear:

fixed with the last commit.

marcushoepfner · 2025-10-09T13:07:35Z

another topic: a user can change the color of the code minings in the "fonts and colors" preference page. If you do this you will see a mix of colors:
Maybe this can be improved:

either by ignoring the users color pref here

also use the code mining color from preferences for the other "white space character" drawing logic.

I tried to ignore and overwrite the color with the one TextEditor uses for drawing spaces, tabs,...
According to

eclipse.platform.ui/bundles/org.eclipse.jface.text/src/org/eclipse/jface/text/WhitespaceCharacterPainter.java

Line 447 in 2c5b605

fg= fTextWidget.getForeground();

this is SWT.COLOR_LIST_FOREGROUND, which is black.
I even debugged the drawing of a tab and it was colored 0, 0, 0 but appeared grey. I dont get it....

BeckerWdf · 2025-10-10T14:32:30Z

I just played around a bit with the current state.
I got this:

java.lang.NullPointerException: Cannot invoke "org.eclipse.swt.widgets.Display.getSystemColor(int)" because the return value of "org.eclipse.swt.widgets.Display.getCurrent()" is null
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMining.<init>(ZeroWidthCharactersLineContentCodeMining.java:40)
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMiningProvider.createCodeMining(ZeroWidthCharactersLineContentCodeMiningProvider.java:108)
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMiningProvider.provideCodeMinings(ZeroWidthCharactersLineContentCodeMiningProvider.java:72)
	at org.eclipse.jface.internal.text.codemining.CodeMiningManager.lambda$2(CodeMiningManager.java:194)
	at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:197)

BeckerWdf · 2025-10-13T05:45:34Z

fixed with the last commit.

Thanks. That looks good now.

BeckerWdf · 2025-10-13T05:46:18Z

I just played around a bit with the current state. I got this:

java.lang.NullPointerException: Cannot invoke "org.eclipse.swt.widgets.Display.getSystemColor(int)" because the return value of "org.eclipse.swt.widgets.Display.getCurrent()" is null
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMining.<init>(ZeroWidthCharactersLineContentCodeMining.java:40)
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMiningProvider.createCodeMining(ZeroWidthCharactersLineContentCodeMiningProvider.java:108)
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMiningProvider.provideCodeMinings(ZeroWidthCharactersLineContentCodeMiningProvider.java:72)
	at org.eclipse.jface.internal.text.codemining.CodeMiningManager.lambda$2(CodeMiningManager.java:194)
	at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:197)

This is now also fixed. Thanks,

marcushoepfner · 2025-10-13T05:55:02Z

I just played around a bit with the current state. I got this:

java.lang.NullPointerException: Cannot invoke "org.eclipse.swt.widgets.Display.getSystemColor(int)" because the return value of "org.eclipse.swt.widgets.Display.getCurrent()" is null
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMining.<init>(ZeroWidthCharactersLineContentCodeMining.java:40)
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMiningProvider.createCodeMining(ZeroWidthCharactersLineContentCodeMiningProvider.java:108)
	at org.eclipse.ui.internal.texteditor.codemining.ZeroWidthCharactersLineContentCodeMiningProvider.provideCodeMinings(ZeroWidthCharactersLineContentCodeMiningProvider.java:72)
	at org.eclipse.jface.internal.text.codemining.CodeMiningManager.lambda$2(CodeMiningManager.java:194)
	at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:197)

This is now also fixed. Thanks,

Is the color of "ZWSP" grey or black in your case?

BeckerWdf · 2025-10-13T05:55:03Z

I tried to ignore and overwrite the color with the one TextEditor uses for drawing spaces, tabs,... According to

eclipse.platform.ui/bundles/org.eclipse.jface.text/src/org/eclipse/jface/text/WhitespaceCharacterPainter.java

Line 447 in 2c5b605

fg= fTextWidget.getForeground();

this is SWT.COLOR_LIST_FOREGROUND, which is black.
I even debugged the drawing of a tab and it was colored 0, 0, 0 but appeared grey. I dont get it....

I also just debugged this. And I see that the color (for the whitespace chars comes from the styleRange not the textWidget:

eclipse.platform.ui/bundles/org.eclipse.jface.text/src/org/eclipse/jface/text/WhitespaceCharacterPainter.java

Line 449 in 2c5b605

fg= styleRange.foreground;

BeckerWdf · 2025-10-13T05:56:12Z

Is the color of "ZWSP" grey or black in your case?

black.

tobiasmelcher · 2026-01-23T14:03:00Z

The WhitespaceCharacterPainter uses in the light theme the black color Color {0, 0, 0, 255} to draw the invisible characters with gc.drawString. It looks greyish because gc.setAlpha(fAlpha); is called beforehand with value fAlpha=80.
Here the location where setAlpha is called.

private void handleDrawRequest(GC gc, int x, int y, int w, int h) {
		int startLine= fTextWidget.getLineIndex(y);
		int endLine= fTextWidget.getLineIndex(y + h - 1);
		if (startLine <= endLine && startLine < fTextWidget.getLineCount()) {

			// avoid painting into the margins:
			Rectangle clipping= gc.getClipping();
			Rectangle clientArea= fTextWidget.getClientArea();
			int leftMargin= fTextWidget.getLeftMargin();
			int rightMargin= fTextWidget.getRightMargin();
			clientArea.x+= leftMargin;
			clientArea.width-= leftMargin + rightMargin;
			clipping.intersect(clientArea);
			gc.setClipping(clientArea);
			if (fIsAdvancedGraphicsPresent) {
				int alpha= gc.getAlpha();
				gc.setAlpha(fAlpha); // <!------------------------------------
				drawLineRange(gc, startLine, endLine, x, w);
				gc.setAlpha(alpha);
			} else {
				drawLineRange(gc, startLine, endLine, x, w);
			}
			gc.setClipping(clipping);
		}
	}

We could do the same in the ZeroWidthCharactersLineContentCodeMining so that all whitespaces are rendered in the same color. Maybe introduce a re-usable in WhitespaceCharacterPainter to retrieve the color config which can then be reused by the code mining.

tobiasmelcher · 2026-01-23T16:30:03Z

[c5d21c1] sets the same color in the ZWSP code minings as it is done in the whitespace character painter

tobiasmelcher · 2026-01-26T17:30:36Z

[b76e3d4] solves the rendering problem on windows.

Here a screenshot with the Consolas font on Windows showing the zero width spaces as code minings.

Here a screenshot with the Courier New font on Windows showing the zero width spaces as code minings.

Here a screenshot with the Monospace font on Linux (Suse) showing the zero width spaces as code minings.

BeckerWdf · 2026-01-27T07:54:05Z

[b76e3d4] solves the rendering problem on windows.

Does it make sense to extract this to an own PR. I assume that we could reproduce this error without this new feature in the whitespace drawer.

This change improves the rendering of code minings in the presence of zero-width Unicode characters (e.g., ZWSP, ZWNJ, ZWJ, and BOM). The `InlinedAnnotationDrawingStrategy` was updated to recognize these characters, adjust their width calculations, and properly place code mining annotations without causing layout issues. This change is needed by eclipse-platform#1437

This change improves the rendering of code minings in the presence of zero-width Unicode characters (e.g., ZWSP, ZWNJ, ZWJ, and BOM). The `InlinedAnnotationDrawingStrategy` was updated to recognize these characters, adjust their width calculations, and properly place code mining annotations without causing layout issues. This change is needed by #1437

BeckerWdf · 2026-02-12T08:40:05Z

don't merge master in your feature branch - we cannot merge these. Pls. rebase your feature branch on top of master.

Issue: eclipse-platform#1002 For more information refer to https://www.compart.com/en/unicode/U+200B To get a ZWSP refer to https://zerowidthspace.me/

marcushoepfner · 2026-02-12T08:47:24Z

don't merge master in your feature branch - we cannot merge these. Pls. rebase your feature branch on top of master.

argh, sorry. It's been a while... :)

BeckerWdf · 2026-02-12T09:09:06Z

Is this PR in "draft" state by intention?

marcushoepfner · 2026-02-12T09:23:40Z

Is this PR in "draft" state by intention?

It is ready-for-review now.
Draft for me means, we still working on it. And that was the case until this morning.

marcushoepfner · 2026-02-12T12:47:58Z

Interesting, the current version in main branch is 3.20

But the API warning says something about 3.19...

I "just" added a new public constant. Why is this considered a broken API? Guess going for 4.0.0 is not an option here :)

iloveeclipse · 2026-02-12T13:11:33Z

Interesting, the current version in main branch is 3.20

And that is the problem

But the API warning says something about 3.19...

Because we don't increase minor version twice for the same release. It was already bumped in 5f6cae6.

So please undo the version increment in manifest and change since tag to 3.20.
After that there will be still API error on org.eclipse.ui.texteditor.AbstractTextEditor.PREFERENCE_SHOW_ZW_CHARACTERS, and you can add a filter for this error in the editor via Ctrl+1.

Also would be good if you could squash all commits to a single one and after that rebase on latest master branch.

iloveeclipse · 2026-02-12T13:13:49Z

But honestly speaking, today is last day for API changes (tomorrow is M3), I don't expect this change qualifies for RC builds, therefore you can keep on the version bump anyway but do the rest and wait for review comments & merge in the next SDK release.

mickaelistria reviewed Dec 19, 2023

View reviewed changes

...r/src/org/eclipse/ui/internal/texteditor/codemining/ZeroWidthSpaceLineContentCodeMining.java Outdated Show resolved Hide resolved

BeckerWdf reviewed Dec 20, 2023

View reviewed changes

...g/eclipse/ui/internal/texteditor/codemining/ZeroWidthSpaceLineContentCodeMiningProvider.java Outdated Show resolved Hide resolved

marcushoepfner force-pushed the zwsp branch 4 times, most recently from b082ac8 to 6cccc08 Compare August 5, 2025 14:06

marcushoepfner marked this pull request as draft August 6, 2025 06:21

marcushoepfner marked this pull request as ready for review August 13, 2025 06:35

BeckerWdf requested changes Aug 13, 2025

View reviewed changes

marcushoepfner force-pushed the zwsp branch from 692f1f0 to 55220bd Compare October 9, 2025 13:02

marcushoepfner force-pushed the zwsp branch 3 times, most recently from 0ee781a to 8b2948b Compare October 9, 2025 13:27

marcushoepfner marked this pull request as draft October 13, 2025 05:20

marcushoepfner force-pushed the zwsp branch from 3b02ed7 to c97d0b4 Compare October 13, 2025 05:59

tobiasmelcher force-pushed the zwsp branch from c97d0b4 to c5d21c1 Compare January 23, 2026 16:16

tobiasmelcher force-pushed the zwsp branch from b76e3d4 to d7f2584 Compare January 26, 2026 17:38

tobiasmelcher mentioned this pull request Feb 2, 2026

Handle zero-width characters properly in code minings #3721

Merged

tobiasmelcher force-pushed the zwsp branch from d7f2584 to dafceda Compare February 3, 2026 08:47

marcushoepfner and others added 11 commits February 12, 2026 09:44

Show ZWSP (zero with space) as code mining

683eaf9

Issue: eclipse-platform#1002 For more information refer to https://www.compart.com/en/unicode/U+200B To get a ZWSP refer to https://zerowidthspace.me/

add other characters

7e4f6d8

rename constants

dc90be0

rename preference

f4e2e57

rename files

531d922

react on toolbar action or general switch-on/off

baf92ce

fix NPE

d06af9b

uses color config from whitespace character painter for code minings

7c18681

fix IllegalArgumentException

9b6ffbc

fix code mining rendering with zero width characters

3a09d99

fix selection color of code mining

3b4a1ca

marcushoepfner force-pushed the zwsp branch from be9718b to 3b4a1ca Compare February 12, 2026 08:45

marcushoepfner marked this pull request as ready for review February 12, 2026 08:47

adapt version

9c125e8

version adapted

b81cb31

BeckerWdf self-requested a review February 12, 2026 12:28

Conversation

marcushoepfner commented Dec 19, 2023

Uh oh!

Uh oh!

github-actions bot commented Dec 19, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Test Results

Uh oh!

BeckerWdf commented Dec 20, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

BeckerWdf commented Aug 13, 2025

Uh oh!

BeckerWdf left a comment

Choose a reason for hiding this comment

Uh oh!

BeckerWdf commented Aug 13, 2025

Uh oh!

marcushoepfner commented Oct 9, 2025

Uh oh!

marcushoepfner commented Oct 9, 2025

Uh oh!

BeckerWdf commented Oct 10, 2025

Uh oh!

BeckerWdf commented Oct 13, 2025

Uh oh!

BeckerWdf commented Oct 13, 2025

Uh oh!

marcushoepfner commented Oct 13, 2025

Uh oh!

BeckerWdf commented Oct 13, 2025

Uh oh!

BeckerWdf commented Oct 13, 2025

Uh oh!

tobiasmelcher commented Jan 23, 2026

Uh oh!

tobiasmelcher commented Jan 23, 2026

Uh oh!

tobiasmelcher commented Jan 26, 2026

Uh oh!

BeckerWdf commented Jan 27, 2026

Uh oh!

BeckerWdf commented Feb 12, 2026

Uh oh!

marcushoepfner commented Feb 12, 2026

Uh oh!

BeckerWdf commented Feb 12, 2026

Uh oh!

marcushoepfner commented Feb 12, 2026

Uh oh!

marcushoepfner commented Feb 12, 2026

Uh oh!

iloveeclipse commented Feb 12, 2026

Uh oh!

iloveeclipse commented Feb 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

github-actions bot commented Dec 19, 2023 •

edited

Loading

BeckerWdf commented Dec 20, 2023 •

edited

Loading