]> gitweb.factorcode.org Git - factor.git/blobdiff - misc/fuel/fuel-autodoc.el
Use lexical scoping in all fuel sources
[factor.git] / misc / fuel / fuel-autodoc.el
index d02e4fcfb95e5f553d3c9419d9940ca9fd3aed35..9b6cb5f59d07fbab66a0b49501ca41b6977edfb8 100644 (file)
@@ -1,4 +1,4 @@
-;;; fuel-autodoc.el -- doc snippets in the echo area
+;;; fuel-autodoc.el -- doc snippets in the echo area -*- lexical-binding: t -*-
 
 ;; Copyright (C) 2008, 2009 Jose Antonio Ortega Ruiz
 ;; See http://factorcode.org/license.txt for BSD license.
 ;;; Code:
 
 (require 'fuel-eval)
-(require 'fuel-font-lock)
-(require 'fuel-syntax)
 (require 'fuel-base)
+(require 'factor-mode)
 
 \f
 ;;; Customization:
 
+;;;###autoload
 (defgroup fuel-autodoc nil
   "Options controlling FUEL's autodoc system."
   :group 'fuel)
   :group 'fuel-autodoc
   :type 'boolean)
 
-
-(defcustom fuel-autodoc-eval-using-form-p nil
-  "When enabled, automatically load vocabularies in USING: form
-to display autodoc messages.
-
-In order to show autodoc messages for words in a Factor buffer,
-the used vocabularies must be loaded in the Factor image. Setting
-this variable to `t' will do that automatically for you,
-asynchronously. That means that you'll be able to move around
-while the vocabs are being loaded, but no other FUEL
-functionality will be available until loading finishes (and it
-may take a while). Thus, this functionality is disabled by
-default. You can force loading the vocabs in a Factor buffer
-USING: form with \\[fuel-load-usings]."
-  :group 'fuel-autodoc
-  :type 'boolean)
-
 \f
 ;;; Eldoc function:
 
 (defvar fuel-autodoc--timeout 200)
 
 (defun fuel-autodoc--word-synopsis (&optional word)
-  (let ((word (or word (fuel-syntax-symbol-at-point)))
+  (let ((word (or word (factor-symbol-at-point)))
         (fuel-log--inhibit-p t))
     (when word
-      (let* ((usings (if fuel-autodoc-eval-using-form-p :usings t))
-             (cmd (if (fuel-syntax--in-using)
-                      `(:fuel* (,word fuel-vocab-summary) :in t)
-                    `(:fuel* ((,word :usings fuel-word-synopsis)) t ,usings)))
-             (ret (fuel-eval--send/wait cmd fuel-autodoc--timeout))
-             (res (fuel-eval--retort-result ret)))
-        (when (and ret (not (fuel-eval--retort-error ret)) (stringp res))
-          (if fuel-autodoc-minibuffer-font-lock
-              (fuel-font-lock--factor-str res)
-            res))))))
-
-(make-variable-buffer-local
- (defvar fuel-autodoc--fallback-function nil))
+      (let ((cmd `(:fuel* (,word ,'fuel-word-synopsis)
+                          ,(factor-current-vocab)
+                          ,(factor-usings))))
+        (let* ((ret (fuel-eval--send/wait cmd fuel-autodoc--timeout))
+               (res (fuel-eval--retort-result ret)))
+          (if (not res)
+              (message "No synposis for '%s'" word)
+            (if fuel-autodoc-minibuffer-font-lock
+                (factor-font-lock-string res)
+              res)))))))
+
+(defvar-local fuel-autodoc--fallback-function nil)
 
 (defun fuel-autodoc--eldoc-function ()
   (or (and fuel-autodoc--fallback-function
@@ -82,10 +64,10 @@ USING: form with \\[fuel-load-usings]."
 \f
 ;;; Autodoc mode:
 
-(make-variable-buffer-local
- (defvar fuel-autodoc-mode-string " A"
-   "Modeline indicator for fuel-autodoc-mode"))
+(defvar-local fuel-autodoc-mode-string " A"
+  "Modeline indicator for fuel-autodoc-mode")
 
+;;;###autoload
 (define-minor-mode fuel-autodoc-mode
   "Toggle Fuel's Autodoc mode.
 With no argument, this command toggles the mode.
@@ -98,12 +80,13 @@ displayed in the minibuffer."
   :lighter fuel-autodoc-mode-string
   :group 'fuel-autodoc
 
-  (set (make-local-variable 'eldoc-documentation-function)
+  (setq-local eldoc-documentation-function
        (when fuel-autodoc-mode 'fuel-autodoc--eldoc-function))
-  (set (make-local-variable 'eldoc-minor-mode-string) nil)
+  (setq-local eldoc-minor-mode-string nil)
   (eldoc-mode fuel-autodoc-mode)
   (message "Fuel Autodoc %s" (if fuel-autodoc-mode "enabled" "disabled")))
 
 \f
 (provide 'fuel-autodoc)
+
 ;;; fuel-autodoc.el ends here