elisp/geiser-autodoc.el

   1 ;; geiser-autodoc.el -- autodoc mode
   2
   3 ;; Copyright (C) 2009, 2010, 2011, 2012, 2015, 2016 Jose Antonio Ortega Ruiz
   4
   5 ;; This program is free software; you can redistribute it and/or
   6 ;; modify it under the terms of the Modified BSD License. You should
   7 ;; have received a copy of the license along with this program. If
   8 ;; not, see <http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5>.
   9
  10 ;; Start date: Sun Feb 08, 2009 19:44
  11
  12 \f
  13
  14 (require 'geiser-eval)
  15 (require 'geiser-syntax)
  16 (require 'geiser-custom)
  17 (require 'geiser-base)
  18
  19 (require 'eldoc)
  20
  21 \f
  22 ;;; Customization:
  23
  24 (defgroup geiser-autodoc nil
  25   "Options for displaying autodoc strings in the echo area."
  26   :group 'geiser)
  27
  28 (geiser-custom--defface autodoc-current-arg
  29   'font-lock-variable-name-face
  30   geiser-autodoc "highlighting current argument in autodoc messages")
  31
  32 (geiser-custom--defface autodoc-identifier
  33   'font-lock-function-name-face
  34   geiser-autodoc "highlighting procedure name in autodoc messages")
  35
  36 (geiser-custom--defcustom geiser-autodoc-delay 0.3
  37   "Delay before autodoc messages are fetched and displayed, in seconds."
  38   :type 'number
  39   :group 'geiser-autodoc)
  40
  41 (geiser-custom--defcustom geiser-autodoc-display-module-p t
  42   "Whether to display procedure module in autodoc strings."
  43   :type 'boolean
  44   :group 'geiser-autodoc)
  45
  46 (geiser-custom--defcustom geiser-autodoc-identifier-format "%s:%s"
  47   "Format for displaying module and procedure or variable name, in that order,
  48 when `geiser-autodoc-display-module-p' is on."
  49   :type 'string
  50   :group 'geiser-autodoc)
  51
  52 \f
  53 ;;; Procedure arguments:
  54
  55 (make-variable-buffer-local
  56  (defvar geiser-autodoc--cached-signatures nil))
  57
  58 (defsubst geiser-autodoc--clean-cache ()
  59   (setq geiser-autodoc--cached-signatures nil))
  60
  61 (defun geiser-autodoc--show-signatures (ret)
  62   (let ((res (geiser-eval--retort-result ret))
  63         (signs))
  64     (when res
  65       (dolist (item res)
  66         (push (cons (format "%s" (car item)) (cdr item)) signs))
  67       (let ((str (geiser-autodoc--autodoc (geiser-syntax--scan-sexps) signs)))
  68         (when (not (string-equal str eldoc-last-message))
  69           (eldoc-message str)))
  70       (setq geiser-autodoc--cached-signatures signs))))
  71
  72 (defun geiser-autodoc--get-signatures (funs)
  73   (when funs
  74     (let ((m (format "'(%s)" (mapconcat 'identity funs " "))))
  75       (geiser-eval--send `(:eval (:ge autodoc (:scm ,m)))
  76                          'geiser-autodoc--show-signatures)))
  77   (and (or (assoc (car funs) geiser-autodoc--cached-signatures)
  78            (assoc (cadr funs) geiser-autodoc--cached-signatures))
  79        geiser-autodoc--cached-signatures))
  80
  81 (defun geiser-autodoc--sanitize-args (args)
  82   (cond ((null args) nil)
  83         ((listp args)
  84          (cons (car args) (geiser-autodoc--sanitize-args (cdr args))))
  85         (t '("..."))))
  86
  87 (defun geiser-autodoc--format-arg (a)
  88   (cond ((and (listp a) (geiser-syntax--keywordp (car a)))
  89          (if (and (cdr a) (listp (cdr a)))
  90              (format "(#%s %s)" (car a) (geiser-syntax--display (cadr a)))
  91            (format "(#%s)" (car a))))
  92         (t (geiser-syntax--display a))))
  93
  94 (defun geiser-autodoc--insert-arg-group (args current &optional pos)
  95   (when args (insert " "))
  96   (dolist (a (geiser-autodoc--sanitize-args args))
  97     (let ((p (point)))
  98       (insert (geiser-autodoc--format-arg a))
  99       (when (or (and (numberp pos)
 100                      (numberp current)
 101                      (setq current (1+ current))
 102                      (= (1+ pos) current))
 103                 (and (geiser-syntax--keywordp current)
 104                      (listp a)
 105                      (geiser-syntax--symbol-eq current (car a))))
 106         (put-text-property p (point)
 107                            'face 'geiser-font-lock-autodoc-current-arg)
 108         (setq pos nil current nil)))
 109     (insert " "))
 110   (when args (backward-char))
 111   current)
 112
 113 (defun geiser-autodoc--insert-args (args pos prev)
 114   (let ((cpos 1)
 115         (reqs (cdr (assoc "required" args)))
 116         (opts (mapcar (lambda (a)
 117                         (if (and (symbolp a)
 118                                  (not (equal (symbol-name a) "...")))
 119                             (list a)
 120                           a))
 121                       (cdr (assoc "optional" args))))
 122         (keys (cdr (assoc "key" args))))
 123     (setq cpos
 124           (geiser-autodoc--insert-arg-group reqs
 125                                             cpos
 126                                             (and (not (zerop pos)) pos)))
 127     (setq cpos (geiser-autodoc--insert-arg-group opts cpos pos))
 128     (geiser-autodoc--insert-arg-group keys prev nil)))
 129
 130 (defsubst geiser-autodoc--id-name (proc module)
 131   (let ((str (if module
 132                  (format geiser-autodoc-identifier-format module proc)
 133                (format "%s" proc))))
 134     (propertize str 'face 'geiser-font-lock-autodoc-identifier)))
 135
 136 (defun geiser-autodoc--str* (full-signature)
 137   (let ((geiser-font-lock-autodoc-current-arg 'default))
 138     (geiser-autodoc--str (list (car full-signature)) full-signature)))
 139
 140 (defsubst geiser-autodoc--value-str (proc module value)
 141   (let ((name (geiser-autodoc--id-name proc module)))
 142     (if value (format "%s => %s" name value) name)))
 143
 144 (defun geiser-autodoc--str (desc signature)
 145   (let ((proc (car desc))
 146         (args (cdr (assoc "args" signature)))
 147         (module (cdr (assoc "module" signature))))
 148     (if (not args)
 149       (geiser-autodoc--value-str proc module (cdr (assoc "value" signature)))
 150       (save-current-buffer
 151         (set-buffer (geiser-syntax--font-lock-buffer))
 152         (erase-buffer)
 153         (insert (format "(%s" (geiser-autodoc--id-name proc module)))
 154         (let ((pos (or (cadr desc) 0))
 155               (prev (car (cddr desc))))
 156           (dolist (a args)
 157             (when (not (member a (cdr (member a args))))
 158               (geiser-autodoc--insert-args a pos prev)
 159               (insert " |"))))
 160         (delete-char -2)
 161         (insert ")")
 162         (buffer-substring (point-min) (point))))))
 163
 164 (defun geiser-autodoc--autodoc (path &optional signs)
 165   (let ((signs (or signs (geiser-autodoc--get-signatures (mapcar 'car path))))
 166         (p (car path))
 167         (s))
 168     (while (and p (not s))
 169       (unless (setq s (cdr (assoc (car p) signs)))
 170         (setq p (car path))
 171         (setq path (cdr path))))
 172     (when s (geiser-autodoc--str p s))))
 173
 174 \f
 175 ;;; Autodoc functions:
 176
 177 (make-variable-buffer-local
 178  (defvar geiser-autodoc--inhibit-function nil))
 179
 180 (defsubst geiser-autodoc--inhibit ()
 181   (and geiser-autodoc--inhibit-function
 182        (funcall geiser-autodoc--inhibit-function)))
 183
 184 (defsubst geiser-autodoc--inhibit-autodoc ()
 185   (setq geiser-autodoc--inhibit-function (lambda () t)))
 186
 187 (defsubst geiser-autodoc--disinhibit-autodoc ()
 188   (setq geiser-autodoc--inhibit-function nil))
 189
 190 (defsubst geiser-autodoc--autodoc-at-point ()
 191   (geiser-autodoc--autodoc (geiser-syntax--scan-sexps)))
 192
 193 (defun geiser-autodoc--eldoc-function ()
 194   (ignore-errors
 195     (when (not (geiser-autodoc--inhibit))
 196       (geiser-autodoc--autodoc-at-point))))
 197
 198 (defun geiser-autodoc-show ()
 199   "Show the signature or value of the symbol at point in the echo area."
 200   (interactive)
 201   (message (geiser-autodoc--autodoc-at-point)))
 202
 203 \f
 204 ;;; Autodoc mode:
 205
 206 (make-variable-buffer-local
 207  (defvar geiser-autodoc-mode-string " A"
 208    "Modeline indicator for geiser-autodoc-mode"))
 209
 210 (define-minor-mode geiser-autodoc-mode
 211   "Toggle Geiser's Autodoc mode.
 212 With no argument, this command toggles the mode.
 213 Non-null prefix argument turns on the mode.
 214 Null prefix argument turns off the mode.
 215
 216 When Autodoc mode is enabled, a synopsis of the word at point is
 217 displayed in the minibuffer."
 218   :init-value nil
 219   :lighter geiser-autodoc-mode-string
 220   :group 'geiser-autodoc
 221
 222   (set (make-local-variable 'eldoc-documentation-function)
 223        (when geiser-autodoc-mode 'geiser-autodoc--eldoc-function))
 224   (set (make-local-variable 'eldoc-minor-mode-string) nil)
 225   (set (make-local-variable 'eldoc-idle-delay) geiser-autodoc-delay)
 226   (eldoc-mode (if geiser-autodoc-mode 1 -1))
 227   (when (called-interactively-p nil)
 228     (message "Geiser Autodoc %s"
 229              (if geiser-autodoc-mode "enabled" "disabled"))))
 230
 231 (defadvice eldoc-display-message-no-interference-p
 232   (after geiser-autodoc--message-ok-p)
 233   (when geiser-autodoc-mode
 234     (setq ad-return-value
 235           (and ad-return-value
 236                ;; Display arglist only when the minibuffer is
 237                ;; inactive, e.g. not on `C-x C-f'. Lifted from slime.
 238                (not (active-minibuffer-window)))))
 239   ad-return-value)
 240
 241
 242 \f
 243 (provide 'geiser-autodoc)