masscollaborationlabs/emacs
2
0
Fork 0
mirror of https://github.com/masscollaborationlabs/emacs.git synced 2025-07-04 11:23:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Eglot: rename and redocument encoding-related functions (bug#61726)

Browse source 
* lisp/progmodes/eglot.el (eglot-current-column): Obsolete.
(eglot-lsp-abiding-column): Obsolete.
(eglot-current-column-function): Obsolete.
(eglot-current-linepos-function): Rename from eglot-current-column-function.
(eglot-utf-8-linepos): Rename from eglot-bytewise-column.
(eglot-utf-16-linepos): Rename from eglot-lsp-abiding-column.
(eglot-utf-32-linepos): Rename from eglot-current-column.
(eglot-move-to-current-column): Obsolete.
(eglot-move-to-lsp-abiding-column): Obsolete.
(eglot-move-to-column-function): Obsolete.
(eglot-move-to-linepos-function): Rename from eglot-move-to-column-function.
(eglot-move-to-utf-8-linepos): Rename from eglot-move-to-bytewise-column.
(eglot-move-to-utf-16-linepos): Rename from eglot-move-to-lsp-abiding-column.
(eglot-move-to-utf-32-linepos): Rename from eglot-move-to-current-column.
(eglot--managed-mode): Adjust.
(eglot-client-capabilities): Trim whitespace.

* test/lisp/progmodes/eglot-tests.el (eglot-test-lsp-abiding-column)
(eglot-test-lsp-abiding-column-1): Use new function/variable names.
This commit is contained in:
João Távora 2023-02-26 12:50:42 +00:00
parent 3e3e6d71be
commit ca79b138d4
2 changed files with 81 additions and 65 deletions
Download patch file Download diff file Expand all files Collapse all files

144
lisp/progmodes/eglot.el
View file

@ -816,9 +816,7 @@ treated as in `eglot--dbind'."
`(:valueSet `(:valueSet
[,@(mapcar [,@(mapcar
#'car eglot--tag-faces)]))) #'car eglot--tag-faces)])))
:general :general (list :positionEncodings ["utf-32" "utf-8" "utf-16"])
(list
:positionEncodings ["utf-32" "utf-8" "utf-16"])
:experimental eglot--{}))) :experimental eglot--{})))
(cl-defgeneric eglot-workspace-folders (server) (cl-defgeneric eglot-workspace-folders (server)
@ -1442,25 +1440,31 @@ CONNECT-ARGS are passed as additional arguments to
(let ((warning-minimum-level :error)) (let ((warning-minimum-level :error))
(display-warning 'eglot (apply #'format format args) :warning))) (display-warning 'eglot (apply #'format format args) :warning)))
(defun eglot-current-column () (- (point) (line-beginning-position)))
;;; Encoding fever
;;;
(define-obsolete-function-alias
'eglot-lsp-abiding-column 'eglot-utf-16-linepos "29.1")
(define-obsolete-function-alias
'eglot-current-column 'eglot-utf-32-linepos "29.1")
(define-obsolete-variable-alias
'eglot-current-column-function 'eglot-current-linepos-function "29.1")
(defun eglot-bytewise-column () (defvar eglot-current-linepos-function #'eglot-utf-16-linepos
"Calculate current column using the LSP `utf-8' criterion." "Function calculating number of code units to line beginning.
This is the inverse operation of
`eglot-move-to-linepos-function' (which see). It is a function of
no arguments returning the number of code units corresponding to
the current position of point relative to line beginning.")
(defun eglot-utf-8-linepos ()
"Calculate number of code units to line beginning using UTF-8."
(length (encode-coding-region (line-beginning-position) (point) (length (encode-coding-region (line-beginning-position) (point)
'utf-8-unix t))) 'utf-8-unix t)))
(defvar eglot-current-column-function #'eglot-lsp-abiding-column (defun eglot-utf-16-linepos (&optional lbp)
"Function to calculate the current column. "Calculate number of code units to line beginning using UTF-16.
This is the inverse operation of
`eglot-move-to-column-function' (which see). It is a function of
no arguments returning a column number. For buffers managed by
fully LSP-compliant servers, this should be set to
`eglot-lsp-abiding-column' (the default), and
`eglot-current-column' for all others.")
(defun eglot-lsp-abiding-column (&optional lbp)
"Calculate current COLUMN as defined by the LSP spec.
LBP defaults to `line-beginning-position'." LBP defaults to `line-beginning-position'."
(/ (- (length (encode-coding-region (or lbp (line-beginning-position)) (/ (- (length (encode-coding-region (or lbp (line-beginning-position))
;; Fix github#860 ;; Fix github#860
@ -1468,60 +1472,71 @@ LBP defaults to `line-beginning-position'."
2) 2)
2)) 2))
(defun eglot-utf-32-linepos ()
"Calculate number of code units to line beginning using UTF-32."
(- (point) (line-beginning-position)))
(defun eglot--pos-to-lsp-position (&optional pos) (defun eglot--pos-to-lsp-position (&optional pos)
"Convert point POS to LSP position." "Convert point POS to LSP position."
(eglot--widening (eglot--widening
;; LSP line is zero-origin; emacs is one-origin. ;; LSP line is zero-origin; emacs is one-origin.
(list :line (1- (line-number-at-pos pos t)) (list :line (1- (line-number-at-pos pos t))
:character (progn (when pos (goto-char pos)) :character (progn (when pos (goto-char pos))
(funcall eglot-current-column-function))))) (funcall eglot-current-linepos-function)))))
(defvar eglot-move-to-column-function #'eglot-move-to-lsp-abiding-column (define-obsolete-function-alias
'eglot-move-to-current-column 'eglot-move-to-utf-32-linepos "29.1")
(define-obsolete-function-alias
'eglot-move-to-lsp-abiding-column 'eglot-move-to-utf-16-linepos "29.1")
(define-obsolete-variable-alias
'eglot-move-to-column-function 'eglot-move-to-linepos-function "29.1")
(defvar eglot-move-to-linepos-function #'eglot-move-to-utf-16-linepos
"Function to move to a column reported by the LSP server. "Function to move to a column reported by the LSP server.
According to the standard, LSP column/character offsets are based Per the LSP spec, character offsets in LSP Position objects count
on a count of UTF-16 code units, not actual visual columns. So UTF-16 code units, not actual code points. So when LSP says
when LSP says position 3 of a line containing just \"aXbc\", position 3 of a line containing just \"aXbc\", where X is a funny
where X is a multi-byte character, it actually means `b', not looking character in the UTF-16 \"supplementary plane\", it
`c'. However, many servers don't follow the spec this closely. actually means `b', not `c'. The default value
`eglot-move-to-utf-16-linepos' accounts for this.
For buffers managed by fully LSP-compliant servers, this should This variable also be set to `eglot-move-to-utf-8-linepos' or
be set to `eglot-move-to-lsp-abiding-column' (the default), and `eglot-move-to-utf-32-linepos' for servers not closely following
`eglot-move-to-column' for all others.") the spec. Also, since LSP 3.17 server and client may agree on an
encoding and Eglot will set this variable automatically.")
(defun eglot-move-to-column (column) (defun eglot-move-to-utf-8-linepos (n)
"Move to COLUMN without closely following the LSP spec." "Move to line's Nth code unit as computed by LSP's UTF-8 criterion."
(let* ((bol (line-beginning-position))
(goal-byte (+ (position-bytes bol) n))
(eol (line-end-position)))
(goto-char bol)
(while (and (< (position-bytes (point)) goal-byte) (< (point) eol))
;; raw bytes take 2 bytes in the buffer
(when (>= (char-after) #x3fff80) (setq goal-byte (1+ goal-byte)))
(forward-char 1))))
(defun eglot-move-to-utf-16-linepos (n)
"Move to line's Nth code unit as computed by LSP's UTF-16 criterion."
(let* ((bol (line-beginning-position))
(goal-char (+ bol n))
(eol (line-end-position)))
(goto-char bol)
(while (and (< (point) goal-char) (< (point) eol))
;; code points in the "supplementary place" use two code units
(when (<= #x010000 (char-after) #x10ffff) (setq goal-char (1- goal-char)))
(forward-char 1))))
(defun eglot-move-to-utf-32-linepos (n)
"Move to line's Nth code unit as computed by LSP's UTF-32 criterion."
;; We cannot use `move-to-column' here, because it moves to *visual* ;; We cannot use `move-to-column' here, because it moves to *visual*
;; columns, which can be different from LSP columns in case of ;; columns, which can be different from LSP characters in case of
;; `whitespace-mode', `prettify-symbols-mode', etc. (github#296, ;; `whitespace-mode', `prettify-symbols-mode', etc. (github#296,
;; github#297) ;; github#297)
(goto-char (min (+ (line-beginning-position) column) (goto-char (min (+ (line-beginning-position) n)
(line-end-position)))) (line-end-position))))
(defun eglot-move-to-lsp-abiding-column (column)
"Move to COLUMN as computed by LSP's UTF-16 criterion."
(let* ((bol (line-beginning-position))
(goal-char (+ bol column))
(eol (line-end-position)))
(goto-char bol)
(while (and (< (point) goal-char)
(< (point) eol))
(if (<= #x010000 (char-after) #x10ffff)
(setq goal-char (1- goal-char)))
(forward-char 1))))
(defun eglot-move-to-bytewise-column (column)
"Move to COLUMN as computed using the LSP `utf-8' criterion."
(let* ((bol (line-beginning-position))
(goal-byte (+ (position-bytes bol) column))
(eol (line-end-position)))
(goto-char bol)
(while (and (< (position-bytes (point)) goal-byte)
(< (point) eol))
(if (>= (char-after) #x3fff80) ; raw bytes take 2 bytes in the buffer
(setq goal-byte (1+ goal-byte)))
(forward-char 1))))
(defun eglot--lsp-position-to-point (pos-plist &optional marker) (defun eglot--lsp-position-to-point (pos-plist &optional marker)
"Convert LSP position POS-PLIST to Emacs point. "Convert LSP position POS-PLIST to Emacs point.
If optional MARKER, return a marker instead" If optional MARKER, return a marker instead"
@ -1532,16 +1547,17 @@ If optional MARKER, return a marker instead"
(forward-line (min most-positive-fixnum (forward-line (min most-positive-fixnum
(plist-get pos-plist :line))) (plist-get pos-plist :line)))
(unless (eobp) ;; if line was excessive leave point at eob (unless (eobp) ;; if line was excessive leave point at eob
(let ((tab-width 1) (let ((col (plist-get pos-plist :character)))
(col (plist-get pos-plist :character)))
(unless (wholenump col) (unless (wholenump col)
(eglot--warn (eglot--warn
"Caution: LSP server sent invalid character position %s. Using 0 instead." "Caution: LSP server sent invalid character position %s. Using 0 instead."
col) col)
(setq col 0)) (setq col 0))
(funcall eglot-move-to-column-function col))) (funcall eglot-move-to-linepos-function col)))
(if marker (copy-marker (point-marker)) (point))))) (if marker (copy-marker (point-marker)) (point)))))
;;; More helpers
(defconst eglot--uri-path-allowed-chars (defconst eglot--uri-path-allowed-chars
(let ((vec (copy-sequence url-path-allowed-chars))) (let ((vec (copy-sequence url-path-allowed-chars)))
(aset vec ?: nil) ;; see github#639 (aset vec ?: nil) ;; see github#639
@ -1778,11 +1794,11 @@ Use `eglot-managed-p' to determine if current buffer is managed.")
(pcase (plist-get (eglot--capabilities (eglot-current-server)) (pcase (plist-get (eglot--capabilities (eglot-current-server))
:positionEncoding) :positionEncoding)
("utf-32" ("utf-32"
(eglot--setq-saving eglot-current-column-function #'eglot-current-column) (eglot--setq-saving eglot-current-linepos-function #'eglot-utf-32-linepos)
(eglot--setq-saving eglot-move-to-column-function #'eglot-move-to-column)) (eglot--setq-saving eglot-move-to-linepos-function #'eglot-move-to-utf-32-linepos))
("utf-8" ("utf-8"
(eglot--setq-saving eglot-current-column-function #'eglot-bytewise-column) (eglot--setq-saving eglot-current-linepos-function #'eglot-utf-8-linepos)
(eglot--setq-saving eglot-move-to-column-function #'eglot-move-to-bytewise-column))) (eglot--setq-saving eglot-move-to-linepos-function #'eglot-move-to-utf-8-linepos)))
(add-hook 'after-change-functions 'eglot--after-change nil t) (add-hook 'after-change-functions 'eglot--after-change nil t)
(add-hook 'before-change-functions 'eglot--before-change nil t) (add-hook 'before-change-functions 'eglot--before-change nil t)
(add-hook 'kill-buffer-hook #'eglot--managed-mode-off nil t) (add-hook 'kill-buffer-hook #'eglot--managed-mode-off nil t)
@ -2616,7 +2632,7 @@ Try to visit the target file for a richer summary line."
(add-face-text-property hi-beg hi-end 'xref-match (add-face-text-property hi-beg hi-end 'xref-match
t substring) t substring)
(list substring (line-number-at-pos (point) t) (list substring (line-number-at-pos (point) t)
(eglot-current-column) (- end beg)))))) (eglot-utf-32-linepos) (- end beg))))))
(`(,summary ,line ,column ,length) (`(,summary ,line ,column ,length)
(cond (cond
(visiting (with-current-buffer visiting (funcall collect))) (visiting (with-current-buffer visiting (funcall collect)))

10
test/lisp/progmodes/eglot-tests.el
View file

@ -856,8 +856,8 @@ pylsp prefers autopep over yafp, despite its README stating the contrary."
'((c-mode . ("clangd"))))) '((c-mode . ("clangd")))))
(with-current-buffer (with-current-buffer
(eglot--find-file-noselect "project/foo.c") (eglot--find-file-noselect "project/foo.c")
(setq-local eglot-move-to-column-function #'eglot-move-to-lsp-abiding-column) (setq-local eglot-move-to-linepos-function #'eglot-move-to-utf-16-linepos)
(setq-local eglot-current-column-function #'eglot-lsp-abiding-column) (setq-local eglot-current-linepos-function #'eglot-utf-16-linepos)
(eglot--sniffing (:client-notifications c-notifs) (eglot--sniffing (:client-notifications c-notifs)
(eglot--tests-connect) (eglot--tests-connect)
(end-of-line) (end-of-line)
@ -866,12 +866,12 @@ pylsp prefers autopep over yafp, despite its README stating the contrary."
(eglot--wait-for (c-notifs 2) (&key params &allow-other-keys) (eglot--wait-for (c-notifs 2) (&key params &allow-other-keys)
(should (equal 71 (cadddr (cadadr (aref (cadddr params) 0)))))) (should (equal 71 (cadddr (cadadr (aref (cadddr params) 0))))))
(beginning-of-line) (beginning-of-line)
(should (eq eglot-move-to-column-function #'eglot-move-to-lsp-abiding-column)) (should (eq eglot-move-to-linepos-function #'eglot-move-to-utf-16-linepos))
(funcall eglot-move-to-column-function 71) (funcall eglot-move-to-linepos-function 71)
(should (looking-at "p"))))))) (should (looking-at "p")))))))
(ert-deftest eglot-test-lsp-abiding-column () (ert-deftest eglot-test-lsp-abiding-column ()
"Test basic `eglot-lsp-abiding-column' and `eglot-move-to-lsp-abiding-column'." "Test basic LSP character counting logic."
(skip-unless (executable-find "clangd")) (skip-unless (executable-find "clangd"))
(eglot-tests--lsp-abiding-column-1)) (eglot-tests--lsp-abiding-column-1))