Open references if definition result has the same range than clicked offset

[InSyncWithFoo]

Currently Ctrl + Click always send textDocument/definition, which might not be ideal when the definition itself is clicked. LSP4IJ integrators should be able to configure that programmatically.

(Filed as requested at this issue.)

[CppCXY]

in VSCode, when you ctrl + click on a reference, it first sends a textDocument/definition request. If the returned range overlaps with the clicked position, it then sends a textDocument/references request.

[CppCXY]

[angelozerr]

Thanks so much @CppCXY for your information.

I see now more the benefit to consume references.

@InSyncWithFoo is it the same usecase in the reported issue from your project?

[InSyncWithFoo]

Yes, that's probably the best behaviour.

[angelozerr]

Yes, that's probably the best behaviour.

Indeed, but do you think it is the behavior that user would like to have?

[InSyncWithFoo]

Of course. They want a panel; we should give them a panel.

[angelozerr]

@InSyncWithFoo after debugging Java support in IJ, I undertand more how the go to declaration is working.

There are 2 means to manage go to declaration:

• extends GotoDeclarationHandler like we did with LSPGotoDeclarationHandler. The advantage to use that is if there are some custom PsiFile (it is your case @InSyncWithFoo I think), the go to declaration will take the priority and if another plugin which manages go to declaration like PyCharm I think,the LSP go to definition will work. The inconevinant to use this GotoDeclarationHandler are:
  • the hyperlinked ignore the LSP location link and with textmate you have this issue https://github.com/redhat-developer/lsp4ij/issues/98
  • there is no way to manage the click action, so it is impossible to Show the References panel.
  • using the PsiFile to collect declarations / references. In the LSP context, we have no custom PsiFile BUT it is possible to get declarations / referernces by implementing PsiSymbolDeclarationProvider / ImplicitReferenceProvider. But there are 2 problems:
  • ImplicitReferenceProvider#getImplicitReferences is called every time (when you do an hoverfor instance), so if we implement textDocument/definition in the getImplicitReferences, it will consume textDocument/definitionevery time. In our case we need to execute getImplicitReferences only when a GoToAction is executed. So we could implement an action listener before/after to enable/disable the call of getImplicitReferences
  • ImplicitReferenceProvider#getImplicitReferences is called only if PsiFile doesn't return references from teh given offset, it means in your case @InSyncWithFoo that you will loose teh LSP go to definition if the hyperlinked PsiElement is done.

What do you think about that @InSyncWithFoo : loosing go to definition (but I think PyCharm should work good) but benefit with Show references panel (and for other language the proper hyperlinked). For many language I think using ImplicitReferenceProvider#getImplicitReferences will be very nice,but before doing that I would liketo know your feeling. If you don't want to loose the LSP go to definition, perhaps we should provide an API to know if the language server must use GotoDeclarationHandler or ImplicitReferenceProvider.

[InSyncWithFoo]

Either seems suboptimal. Hyperlinking is a small problem, so I slightly prefer the first in this "choose your poison" situation.

I'm not familiar with these extension points though. Take this comment only at face value.