From: "João Távora" <joaotavora@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 61726@debbugs.gnu.org, arstoffel@gmail.com
Subject: bug#61726: [PATCH] Eglot: Support positionEncoding capability
Date: Sun, 26 Feb 2023 15:15:57 +0000 [thread overview]
Message-ID: <87zg90o3te.fsf@gmail.com> (raw)
In-Reply-To: <83r0uciiqi.fsf@gnu.org> (Eli Zaretskii's message of "Sun, 26 Feb 2023 16:50:13 +0200")
Eli Zaretskii <eliz@gnu.org> writes:
>> But as I said this is just a nit.
>
> I made one more fix.
FTR, I think it's way worse now. The function variable has no clear
protocol: it's very odd to state its return type as number of code units
_or_ bytes _or_ code points. A good docstring for such a variable notes
that, for any buffer position, a plugged-in function must return the
same _type_ but may return a different _value_ to match the
unit-counting strategy being used by the LSP server.
I haven't reverted to avoid a commit war, and because I'm a bit weary of
this bug. I leave a patch for consideration and for the record, feel
free to ignore it.
João
diff --git a/lisp/progmodes/eglot.el b/lisp/progmodes/eglot.el
index dd84f545ed4..12fb72503aa 100644
--- a/lisp/progmodes/eglot.el
+++ b/lisp/progmodes/eglot.el
@@ -1453,11 +1453,20 @@ eglot--warn
(defvar eglot-current-linepos-function #'eglot-utf-16-linepos
"Function calculating position relative to line beginning.
-This is the inverse of `eglot-move-to-linepos-function' (which see).
-It is a function of no arguments returning the number of code units
-or bytes or codepoints corresponding to the current position of point,
-relative to line beginning, as expected by the function that is the
-value of `eglot-move-to-linepos-function'.")
+This is the inverse operation of
+`eglot-move-to-linepos-function' (which see). The value is a
+nullary function that examines current `point' and computes the
+number of code units relative to line beginning in such a way
+that it matches how the LSP server also counts code units. For
+example, if the LSP server is using UTF-16 encoding, and point is
+on the \"b\" of a line containing just \"aXbc\" where \"X\" is a
+funny looking character in the UTF-16 \"supplementary plane\",
+this function has to return 3 code points instead of 2. If the
+server is using UTF-32 encoding, this function should return 2
+code points.
+
+Since LSP 3.17 server and client may agree on an encoding and
+Eglot will set this variable automatically.")
(defun eglot-utf-8-linepos ()
"Calculate number of UTF-8 bytes from line beginning."
@@ -1496,11 +1505,11 @@ eglot-move-to-linepos-function
"Function to move to a position within a line reported by the LSP server.
Per the LSP spec, character offsets in LSP Position objects count
-UTF-16 code units, not actual code points. So when LSP says
-position 3 of a line containing just \"aXbc\", where X is a funny
-looking character in the UTF-16 \"supplementary plane\", it
-actually means `b', not `c'. The default value
-`eglot-move-to-utf-16-linepos' accounts for this.
+code units, not actual code points. The default is to use UTF-16
+encoding, so when LSP says position 3 of a line containing just
+\"aXbc\", where \"X\" is a funny looking character in the UTF-16
+\"supplementary plane\", it actually means \"b\", not \"c\". The
+default value `eglot-move-to-utf-16-linepos' accounts for this.
This variable can also be set to `eglot-move-to-utf-8-linepos' or
`eglot-move-to-utf-32-linepos' for servers not closely following
next prev parent reply other threads:[~2023-02-26 15:15 UTC|newest]
Thread overview: 82+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-23 8:05 bug#61726: [PATCH] Eglot: Support positionEncoding capability Augusto Stoffel
2023-02-23 10:39 ` Eli Zaretskii
2023-02-23 11:32 ` João Távora
2023-02-23 12:04 ` Augusto Stoffel
2023-02-23 12:24 ` João Távora
2023-02-23 11:46 ` Augusto Stoffel
2023-02-23 12:54 ` Eli Zaretskii
2023-02-23 13:31 ` Augusto Stoffel
2023-02-23 15:04 ` Eli Zaretskii
2023-02-23 18:52 ` Augusto Stoffel
2023-02-23 19:20 ` Eli Zaretskii
2023-02-23 19:28 ` João Távora
2023-02-23 19:52 ` Augusto Stoffel
2023-02-24 6:43 ` Eli Zaretskii
2023-02-24 7:18 ` Augusto Stoffel
2023-02-24 8:38 ` Eli Zaretskii
2023-02-24 9:15 ` Augusto Stoffel
2023-02-24 10:20 ` João Távora
2023-02-24 11:01 ` Augusto Stoffel
2023-02-24 11:18 ` João Távora
2023-02-24 11:47 ` Augusto Stoffel
2023-02-24 12:05 ` João Távora
2023-02-24 12:14 ` Augusto Stoffel
2023-02-24 11:38 ` Eli Zaretskii
2023-02-24 11:55 ` João Távora
2023-02-24 11:27 ` Eli Zaretskii
2023-02-24 11:43 ` João Távora
2023-02-24 11:57 ` Eli Zaretskii
2023-02-24 12:09 ` João Távora
2023-02-24 12:18 ` Eli Zaretskii
2023-02-24 12:31 ` Augusto Stoffel
2023-02-24 12:01 ` Augusto Stoffel
2023-02-24 12:16 ` Eli Zaretskii
2023-02-24 12:35 ` Augusto Stoffel
2023-02-24 12:55 ` João Távora
2023-02-24 13:34 ` Eli Zaretskii
2023-02-24 13:45 ` João Távora
2023-02-24 13:51 ` Eli Zaretskii
2023-02-24 14:45 ` Augusto Stoffel
2023-02-24 15:19 ` Eli Zaretskii
2023-02-24 15:52 ` Augusto Stoffel
2023-02-24 16:01 ` Eli Zaretskii
2023-02-24 16:39 ` Augusto Stoffel
2023-02-24 17:07 ` Eli Zaretskii
2023-02-24 18:08 ` Augusto Stoffel
2023-02-24 18:55 ` João Távora
2023-02-25 10:58 ` Eli Zaretskii
2023-03-05 10:26 ` Augusto Stoffel
2023-02-25 10:57 ` Eli Zaretskii
2023-02-25 11:29 ` Augusto Stoffel
2023-02-25 13:47 ` Eli Zaretskii
2023-02-25 14:14 ` Augusto Stoffel
2023-02-25 16:26 ` Eli Zaretskii
2023-02-25 18:10 ` Augusto Stoffel
2023-02-25 22:15 ` João Távora
2023-02-25 22:13 ` João Távora
2023-02-25 22:34 ` Augusto Stoffel
2023-02-25 23:16 ` João Távora
2023-02-25 23:57 ` Augusto Stoffel
2023-02-26 6:03 ` Eli Zaretskii
2023-02-26 10:33 ` João Távora
2023-02-26 13:13 ` João Távora
2023-02-26 13:16 ` Eli Zaretskii
2023-02-26 13:25 ` Eli Zaretskii
2023-02-26 14:17 ` João Távora
2023-02-26 14:50 ` Eli Zaretskii
2023-02-26 15:15 ` João Távora [this message]
2023-02-26 15:37 ` Eli Zaretskii
2023-02-27 11:15 ` João Távora
2023-02-26 5:31 ` Eli Zaretskii
2023-02-26 10:38 ` João Távora
2023-02-24 14:54 ` Augusto Stoffel
2023-02-24 15:23 ` Eli Zaretskii
2023-02-24 15:56 ` Augusto Stoffel
2023-02-24 17:02 ` Eli Zaretskii
2023-02-24 16:34 ` João Távora
2023-02-24 17:06 ` Eli Zaretskii
2023-02-23 11:37 ` João Távora
2023-02-23 17:01 ` Felician Nemeth
2023-02-23 17:11 ` João Távora
2023-02-23 18:42 ` Augusto Stoffel
2023-02-27 10:11 ` Felician Nemeth
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=87zg90o3te.fsf@gmail.com \
--to=joaotavora@gmail.com \
--cc=61726@debbugs.gnu.org \
--cc=arstoffel@gmail.com \
--cc=eliz@gnu.org \
/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).