1 ;;; fuel-autodoc.el -- doc snippets in the echo area
3 ;; Copyright (C) 2008, 2009 Jose Antonio Ortega Ruiz
4 ;; See http://factorcode.org/license.txt for BSD license.
6 ;; Author: Jose Antonio Ortega Ruiz <jao@gnu.org>
7 ;; Keywords: languages, fuel, factor
8 ;; Start date: Sat Dec 20, 2008 00:50
12 ;; Utilities for displaying information automatically in the echo
18 (require 'fuel-font-lock)
19 (require 'fuel-syntax)
25 (defgroup fuel-autodoc nil
26 "Options controlling FUEL's autodoc system."
29 (defcustom fuel-autodoc-minibuffer-font-lock t
30 "Whether to use font lock for info messages in the minibuffer."
38 (defvar fuel-autodoc--timeout 200)
40 (defun fuel-autodoc--word-synopsis (&optional word)
41 (let ((word (or word (fuel-syntax-symbol-at-point)))
42 (fuel-log--inhibit-p t))
44 (let* ((cmd (if (fuel-syntax--in-using)
45 `(:fuel* (,word fuel-vocab-summary) :in t)
46 `(:fuel* (((:quote ,word) synopsis :get)) :in)))
47 (ret (fuel-eval--send/wait cmd fuel-autodoc--timeout))
48 (res (fuel-eval--retort-result ret)))
49 (when (and ret (not (fuel-eval--retort-error ret)) (stringp res))
50 (if fuel-autodoc-minibuffer-font-lock
51 (fuel-font-lock--factor-str res)
54 (make-variable-buffer-local
55 (defvar fuel-autodoc--fallback-function nil))
57 (defun fuel-autodoc--eldoc-function ()
58 (or (and fuel-autodoc--fallback-function
59 (funcall fuel-autodoc--fallback-function))
60 (fuel-autodoc--word-synopsis)))
65 (make-variable-buffer-local
66 (defvar fuel-autodoc-mode-string " A"
67 "Modeline indicator for fuel-autodoc-mode"))
69 (define-minor-mode fuel-autodoc-mode
70 "Toggle Fuel's Autodoc mode.
71 With no argument, this command toggles the mode.
72 Non-null prefix argument turns on the mode.
73 Null prefix argument turns off the mode.
75 When Autodoc mode is enabled, a synopsis of the word at point is
76 displayed in the minibuffer."
78 :lighter fuel-autodoc-mode-string
81 (set (make-local-variable 'eldoc-documentation-function)
82 (when fuel-autodoc-mode 'fuel-autodoc--eldoc-function))
83 (set (make-local-variable 'eldoc-minor-mode-string) nil)
84 (eldoc-mode fuel-autodoc-mode)
85 (message "Fuel Autodoc %s" (if fuel-autodoc-mode "enabled" "disabled")))
88 (provide 'fuel-autodoc)
89 ;;; fuel-autodoc.el ends here