textDocumentPositionParams: add optional range

[adonovan]

This change adds an optional range field to textDocumentPositionParams so that clients can, for example, query a subexpression such as x.f within a larger expression g(x.f[i]).

Also, clarify the text about cursor bias.

Fixes #377
Fixes #1029

[adonovan]

@microsoft-github-policy-service agree company="Google"

[dbaeumer]

@adonovan to merge something into the spec we usually require an implementation in at least one client. Are you willing to provide that as well.

And I was wondering if we at least should flag this as a feature / capability from the client side so that the servers know what to expect. In VS Code for example there will be a lot of cases where we can't fill in the range since it is not part of the original API request and getting it from the active editor is not possible (e.g. there might not be one, the cursor has been moved, ...)

[adonovan]

@adonovan to merge something into the spec we usually require an implementation in at least one client. Are you willing to provide that as well.

I already have an implementation in eglot (Emacs): it's just a few lines.

And I was wondering if we at least should flag this as a feature / capability from the client side so that the servers know what to expect. In VS Code for example there will be a lot of cases where we can't fill in the range since it is not part of the original API request and getting it from the active editor is not possible (e.g. there might not be one, the cursor has been moved, ...)

I don't think this needs to be a capability; it's just an optional field, and its type tells the server that it can't be relied upon.

[adonovan]

Sorry for not providing it earlier, but here's the diff to eglot:

 (defun eglot--TextDocumentPositionParams ()
   "Compute TextDocumentPositionParams."
   (list :textDocument (eglot--TextDocumentIdentifier)
-        :position (eglot--pos-to-lsp-position)))
+        :position (eglot--pos-to-lsp-position))   
+   (if (region-active-p)
+       (list :range 
+	     (list :start (eglot--pos-to-lsp-position (region-beginning))
+		   :end (eglot--pos-to-lsp-position (region-end)))))))

[adonovan]

Is there anything we can do to help move this process along?

[xzbdmw]

to merge something into the spec we usually require an implementation in at least one client

The "one client" seems always mean vscode.