fix: don't log same BadLocationException excessively

[sebthom]

The goal of this PR is to address #899 , #536 and #203 by logging BadLocationExceptions in LSPDiagnosticsToMarkers and SymbolsLabelProvider only when Platform.getDebugOption("org.eclipse.lsp4e/debug") is set to true.

[rubenporras]

I prefer to have the exceptions in the log if the error happens.

Otherwise the user will still miss some feature and will not know why.

Is the error such a problem that we would like to hide it?

[sebthom]

I guess the problem is the amount of exceptions being logged repetitively and since it has been reported several times it seems to be an annoyance to users. Also in the error log view there is the option "Activate on new error" which would frequently re-activate that view.

Maybe we can just lower the severity to warning or info instead of error?

[rubenporras]

What about counting exceptions and only log the first three unless in debug mode?

I think that is a good compromise between informing the user and not bothering him

[sebthom]

What about counting exceptions and only log the first three unless in debug mode?

I think that is a good compromise between informing the user and not bothering him

@rubenporras ok, please check my update

[rubenporras]

Thanks