steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
factor/misc/fuel/fuel-autodoc.el

93 lines
2.5 KiB
EmacsLisp
Raw Normal View History

FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
;;; fuel-autodoc.el -- doc snippets in the echo area
FUEL: Help system overhaul.
2009-01-03 10:37:28 -05:00
;; Copyright (C) 2008, 2009 Jose Antonio Ortega Ruiz
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
;; See http://factorcode.org/license.txt for BSD license.
;; Author: Jose Antonio Ortega Ruiz <jao@gnu.org>
;; Keywords: languages, fuel, factor
;; Start date: Sat Dec 20, 2008 00:50
;;; Comentary:
;; Utilities for displaying information automatically in the echo
;; area.
;;; Code:
(require 'fuel-eval)
(require 'fuel-base)
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
(require 'factor-mode)
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
;;; Customization:
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
;;;###autoload
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
(defgroup fuel-autodoc nil
FUEL: Customization docstrings homogenized.
2008-12-21 19:51:41 -05:00
"Options controlling FUEL's autodoc system."
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
:group 'fuel)
(defcustom fuel-autodoc-minibuffer-font-lock t
"Whether to use font lock for info messages in the minibuffer."
:group 'fuel-autodoc
:type 'boolean)
FUEL: Increase autodoc timeout.
2008-12-30 18:23:44 -05:00
;;; Eldoc function:
(defvar fuel-autodoc--timeout 200)
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
(defun fuel-autodoc--word-synopsis (&optional word)
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
(let ((word (or word (factor-symbol-at-point)))
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
(fuel-log--inhibit-p t))
(when word
FUEL: ensuring that autodoc works for qualified word references (eg unix.ffi:accept)
2017-01-07 09:20:13 -05:00
(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)))))))
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
(defvar-local fuel-autodoc--fallback-function nil)
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
(defun fuel-autodoc--eldoc-function ()
(or (and fuel-autodoc--fallback-function
(funcall fuel-autodoc--fallback-function))
FUEL: Nicer autodoc error messages.
2009-01-08 21:45:04 -05:00
(condition-case e
(fuel-autodoc--word-synopsis)
(error (format "Autodoc not available (%s)"
(error-message-string e))))))
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
FUEL: Increase autodoc timeout.
2008-12-30 18:23:44 -05:00
;;; Autodoc mode:
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
(defvar-local fuel-autodoc-mode-string " A"
"Modeline indicator for fuel-autodoc-mode")
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
;;;###autoload
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
(define-minor-mode fuel-autodoc-mode
"Toggle Fuel's Autodoc mode.
With no argument, this command toggles the mode.
Non-null prefix argument turns on the mode.
Null prefix argument turns off the mode.
When Autodoc mode is enabled, a synopsis of the word at point is
displayed in the minibuffer."
:init-value nil
:lighter fuel-autodoc-mode-string
:group 'fuel-autodoc
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
(setq-local eldoc-documentation-function
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
(when fuel-autodoc-mode 'fuel-autodoc--eldoc-function))
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
(setq-local eldoc-minor-mode-string nil)
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
(eldoc-mode fuel-autodoc-mode)
(message "Fuel Autodoc %s" (if fuel-autodoc-mode "enabled" "disabled")))
(provide 'fuel-autodoc)
Large reorg of FUEL codebase * Modernize the FUEL elisp code for Emacs 24.3. Emacs 24.3 deprecated the old 'cl lib and standardized a new 'cl-lib lib to put the name clash issues to rest once and for all. This version of FUEL now requires 24.3. * Move FUEL code that was needed by factor-mode into factor-mode and rename appropriately. factor-mode and FUEL are now clearly separated and FUEL depends on factor-mode. * Set up FUEL with appropriate autoloads so that it's Emacs 24 package manager friendly. FUEL can now be uploaded to MELPA or some similar package manager. * Changed the Factor faces for font locking to inherit from the default Emacs faces rather than defaulting to other colors. This means that Emacs themes will work for Factor code out of the box. Further tailoring of Factor-specific faces can be done by users themselves. * Cleaned up a lot of code to use Emacs conventions (define-defined-mode, define-minor-mode, indent-function, etc) and added a propery syntax table so that paren matching works, and word/symbol skipping works. * Added a new minor mode, fuel-autohelp-mode, that displays the help for the symbol under point in another window. A fusion of fuel-autodoc-mode and fuel-help-mode that's quite handy for reading Factor code.
2013-05-05 00:48:12 -04:00
FUEL: Stack inference support.
2008-12-20 10:51:05 -05:00
;;; fuel-autodoc.el ends here