unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Fangrui Song <emacsray@gmail.com>
To: Dmitry Gutov <dgutov@yandex.ru>
Cc: 29619@debbugs.gnu.org
Subject: bug#29619: Fwd: [xref.el] Add `xref-find-references` to `xref-prompt-for-identifier`
Date: Sun, 10 Dec 2017 23:18:54 -0800	[thread overview]
Message-ID: <20171211071854.qfrignlnlj57yzgl@hacking> (raw)
In-Reply-To: <0e97609a-eefc-6e0d-ce2b-6c69651d9990@yandex.ru>


On 2017-12-10, Dmitry Gutov wrote:
>On 12/9/17 7:52 PM, Ray wrote:
>>Thanks for being open to change the default if more people feel the same.
>>
>>With the xref system people use drifting from tag based
>>(ctags,etags,GNU GLOBAL,cscope,...) tools to Language Server Protocol
>>(cquery, rls, ...),
>>a single identifier without position has become insufficient to
>>describe the one the user wants to look up. For example, a local
>>variable/struct/lambda `foo` may exist
>>in different functions.
>
>That's fine, actually, and as designed. As long as the different 
>global identifiers can be represented uniquely as strings (but using 
>text properties for e.g. a local variable at point is good too).

>>I'm using a C++ language server called cquery. This is what I get (for
>>the argument `identifier`) when I hit the key bound to
>>`xref-find-definitions`:
>>
>>#("QueryDatabase" 0 13 (fontified t ref-params (:textDocument (:uri
>>"file:///home/maskray/Dev/Util/cquery/src/query_utils.h") :position
>>(:line 11 :character 54) :context (:includeDeclaration :json-false))
>>def-params (:textDocument (:uri
>>"file:///home/maskray/Dev/Util/cquery/src/query_utils.h") :position
>>(:line 11 :character 54))))
>>
>>Here the text properties are more useful than the identifier itself,
>>because LSP uses position instead of identifier to sending requests to
>>the language server.
>>https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md#textdocumentpositionparams
>
>So it doesn't actually let you choose? Only supports the identifier at 
>point?

The identifier (if chosen from xref prompt) is ignored by Language
Server Protocol and only the position information is what matters.

According to https://github.com/Microsoft/language-server-protocol/blob/master/protocol.md#textDocument_references
When the user wants to find a reference of an identifier,
information of the following interface is sent to language servers.

    interface ReferenceParams extends TextDocumentPositionParams {
    	context: ReferenceContext
    }

TextDocumentPositionParams is the interesting one:

    interface TextDocumentPositionParams {
    	textDocument: TextDocumentIdentifier;   /// wrapper of filename
    	position: Position;  /// line, column; see, no identifier is used
    }

lsp-mode provides a backend of xref generic functions.
Here is how xref-find-references is implemented in lsp-mode:
https://github.com/emacs-lsp/lsp-mode/blob/master/lsp-methods.el#L1425

    (cl-defmethod xref-backend-references ((_backend (eql xref-lsp)) identifier)
      (let* ((properties (text-properties-at 0 identifier))
             (params (plist-get properties 'ref-params))
             (refs (lsp--send-request (lsp--make-request
                                       "textDocument/references"
                                       (or params (lsp--make-reference-params))))))
        (lsp--locations-to-xref-items refs)))

The `identifier` text itself is ignored and only the text properties
(which encode position information) are used.





  reply	other threads:[~2017-12-11  7:18 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <CAN30aBF0FcQpH+DDxR5ggWgwYHPn41nzdgNdUXSt2j0mXY39-A@mail.gmail.com>
2017-12-08 21:27 ` bug#29619: Fwd: [xref.el] Add `xref-find-references` to `xref-prompt-for-identifier` Ray
2017-12-09 15:25   ` Dmitry Gutov
2017-12-09 17:52     ` Ray
2017-12-10 16:57       ` Dmitry Gutov
2017-12-11  7:18         ` Fangrui Song [this message]
2017-12-11 10:38           ` Dmitry Gutov
2018-01-21 22:20   ` guillaume papin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20171211071854.qfrignlnlj57yzgl@hacking \
    --to=emacsray@gmail.com \
    --cc=29619@debbugs.gnu.org \
    --cc=dgutov@yandex.ru \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).