Multi line error message fixed

[jannisCode]

What it does

This PR solves the issue from here: (vi-eclipse/Eclipse-Platform#130 (comment))

Before

The error message did not handle the different widths of characters well. Especially the ^ was on the wrong charachter, basically making it useless.

After

Now the ^ is on the right character, no matter what the user types in.

[github-actions]

Test Results

 1 820 files   -  1   1 820 suites   - 1   1h 52m 37s ⏱️ + 4m 39s
 7 714 tests ± 0   7 484 ✅  -  2  228 💤 ± 0  2 ❌ +2 
24 258 runs   - 45  23 519 ✅  - 37  737 💤  - 10  2 ❌ +2 

For more details on these failures, see this check.

Results for commit 506587a. ± Comparison against base commit 4fbbe1b.

♻️ This comment has been updated with latest results.

[fedejeanne]

I have some minor comments regarding the coding style.

I also tested it and sometimes the ^ is a bit off.

Regex: [ --> ✔️

Regex: [d --> ✔️

Regex: [df --> ❌ (a bit to the right)

Maybe you can work with Hair spaces or Thin spaces?

[Wittmaxi]

I think it is important to mention here that this PR relies very heavily on the RegEx error message format.
Any changes to that format or any errors on the compiler side would fail silently

https://docs.oracle.com/javase/8/docs/api/java/util/regex/PatternSyntaxException.html#getIndex--
https://docs.oracle.com/javase/8/docs/api/java/util/regex/PatternSyntaxException.html#getPattern--

Java DOES have a method that helps with building your own error message - the catch: the FindReplaceTargetStatus object does not provide them. It should be rather easy to add those into the object and to modify the message generator if required.

[Wittmaxi]

Modify in org.eclipse.ui.internal.findandreplace.status.InvalidRegExStatus

	public int getIndex() {
		return regExException.getIndex();
	}

	public String getPattern() {
		return regExException.getPattern();
	}

[fedejeanne]

Suggested change

[jannisCode]

done

[jannisCode]

done

[fedejeanne]

@jannisCode please adapt the commit message to suit the recommendations

It still looks odd with [df

[jannisCode]

I now changed the while loop, so that it works better with the example [df. Unfortunately it doesn´t handle very wide characters like m or o as well as before then.

[fedejeanne]

As discussed in today's call, here are some tips:

• Don't pass the ControlDecoration as a parameter, only the Control,
• Return earlier in case e.getIndex() == -1 and avoid creating a StringBuffer,
• Extract methods from the whole catch block to improve readability,
• Use hair spaces (they are thinner than thin spaces)
• Try to compute the amount of hair spaces that you need to add before the ^. In the end, the ideal result is when the tip of the "^" is placed right in the middle of the offending character.

[fedejeanne]

The results are much better now. There are only a few comments about the coding but after they are addressed, this PR will be ready to go 👍

[fedejeanne]

Failed check: see #2432

[fedejeanne]

@jannisCode which changes did you introduce when you force-pushed 3c3d8cc? I can't see any difference in the code when I compare it to my previous commit (9362717), only that you removed me as co-author.

[jannisCode]

@fedejeanne I am pretty sure that it was just an update with rebase. I definitely didn´t mean to remove you as co-author

[fedejeanne]

@fedejeanne I am pretty sure that it was just an update with rebase. I definitely didn´t mean to remove you as co-author

👍
I removed some unnecessary empty lines and pushed again. I also wanted to test if the failing tests were unrelated to this PR (I think they are).

After the checks are done, I will merge this. Please do not push any more changes.

[fedejeanne]

@jannisCode care to add a N&N entry? :-)