rustowl 0.3.4

Visualize Ownership and Lifetimes in Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

;;; rustowl.el --- Visualize Ownership and Lifetimes in Rust -*- lexical-binding: t; -*-

;; Copyright (C) cordx56

;; Author: cordx56
;; Keywords: tools

;; Version: 0.2.0
;; Package-Requires: ((emacs "24.1") (lsp-mode "9.0.0"))
;; URL: https://github.com/cordx56/rustowl

;; SPDX-License-Identifier: MPL-2.0

;;; Commentary:

;;; Code:

(require 'lsp-mode)

(defgroup rustowl ()
  "Visualize Ownership and Lifetimes in Rust"
  :group 'tools
  :prefix "rustowl-"
  :link '(url-link "https://github.com/cordx56/rustowl"))

;;;###autoload
(with-eval-after-load 'lsp-mode
  (lsp-register-client
   (make-lsp-client
    :new-connection (lsp-stdio-connection '("rustowl"))
    :major-modes '(rust-mode)
    :server-id 'rustowl
    :priority -1
    :add-on? t)))

(defun rustowl-cursor (params)
  (lsp-request-async
   "rustowl/cursor"
   params
   (lambda (response)
     (let ((decorations (gethash "decorations" response)))
       (mapc
        (lambda (deco)
          (let* ((type (gethash "type" deco))
                 (start (gethash "start" (gethash "range" deco)))
                 (end (gethash "end" (gethash "range" deco)))
                 (start-pos
                  (rustowl-line-col-to-pos
                   (gethash "line" start)
                   (gethash "character" start)))
                 (end-pos
                  (rustowl-line-col-to-pos
                   (gethash "line" end)
                   (gethash "character" end)))
                 (overlapped (gethash "overlapped" deco)))
            (if (not overlapped)
              (cond
               ((equal type "lifetime")
                (rustowl-underline start-pos end-pos "#00cc00"))
               ((equal type "imm_borrow")
                (rustowl-underline start-pos end-pos "#0000cc"))
               ((equal type "mut_borrow")
                (rustowl-underline start-pos end-pos "#cc00cc"))
               ((or (equal type "move") (equal type "call"))
                (rustowl-underline start-pos end-pos "#cccc00"))
               ((equal type "outlive")
                (rustowl-underline start-pos end-pos "#cc0000"))))))
        decorations)))
   :mode 'current))


(defun rustowl-line-number-at-pos ()
  (save-excursion
    (goto-char (point))
    (count-lines (point-min) (line-beginning-position))))
(defun rustowl-current-column ()
  (save-excursion
    (let ((start (point)))
      (move-beginning-of-line 1)
      (- start (point)))))

(defun rustowl-cursor-call ()
  (let ((line (rustowl-line-number-at-pos))
        (column (rustowl-current-column))
        (uri (lsp--buffer-uri)))
    (rustowl-cursor `(
                        :position ,`(
                                    :line ,line
                                    :character ,column
                                    )
                        :document ,`(
                                     :uri ,uri
                                     )
                        ))))

;;;###autoload
(defvar rustowl-cursor-timer nil)
;;;###autoload
(defvar rustowl-cursor-timeout 2)

;;;###autoload
(defun rustowl-reset-cursor-timer ()
  (when rustowl-cursor-timer
    (cancel-timer rustowl-cursor-timer))
  (rustowl-clear-overlays)
  (setq rustowl-cursor-timer
        (run-with-idle-timer rustowl-cursor-timeout nil #'rustowl-cursor-call)))

;;;###autoload
(defun enable-rustowl-cursor ()
  (add-hook 'post-command-hook #'rustowl-reset-cursor-timer))

;;;###autoload
(defun disable-rustowl-cursor ()
  (remove-hook 'post-command-hook #'rustowl-reset-cursor-timer)
  (when rustowl-cursor-timer
    (cancel-timer rustowl-cursor-timer)
    (setq rustowl-cursor-timer nil)))

;; RustOwl visualization
(defun rustowl-line-col-to-pos (line col)
  (save-excursion
    (goto-char (point-min))
    (forward-line line)
    (move-to-column col)
    (point)))

(defvar rustowl-overlays nil)

(defun rustowl-underline (start end color)
  (let ((overlay (make-overlay start end)))
    (overlay-put overlay 'face `(:underline (:color ,color :style wave)))
    (push overlay rustowl-overlays)
    overlay))

(defun rustowl-clear-overlays ()
  (interactive)
  (mapc #'delete-overlay rustowl-overlays)
  (setq rustowl-overlays nil))

(provide 'rustowl)
;;; rustowl.el ends here