mirror of
https://git.savannah.gnu.org/git/emacs.git
synced 2024-11-24 07:20:37 +00:00
cd4208f6d8
* lisp/comint.el (comint-fontify-input-mode): (comint--fontify-input-saved-jit-lock-contextually): (comint--fontify-input-on): (comint--fontify-input-off): (comint--fontify-input-ppss-flush-indirect): (comint--fontify-input-fontify-region): Replace comint-fl-* with comint-fontify-input-*. * lisp/ielm.el (ielm-fontify-input-enable): (ielm-fontify-input-enable): (ielm-indirect-setup-hook): (inferior-emacs-lisp-mode): Replace comint-fl-* with comint-fontify-input-*. * lisp/shell.el (shell-comint-fl-enable): (shell-mode): Replace comint-fl-* with comint-fontify-input-*. * etc/NEWS: Mention the new modes and how to disable or enable them (bug#58169).
659 lines
26 KiB
EmacsLisp
659 lines
26 KiB
EmacsLisp
;;; ielm.el --- interaction mode for Emacs Lisp -*- lexical-binding: t -*-
|
|
|
|
;; Copyright (C) 1994, 2001-2022 Free Software Foundation, Inc.
|
|
|
|
;; Author: David Smith <maa036@lancaster.ac.uk>
|
|
;; Maintainer: emacs-devel@gnu.org
|
|
;; Created: 25 Feb 1994
|
|
;; Keywords: lisp
|
|
|
|
;; This file is part of GNU Emacs.
|
|
|
|
;; GNU Emacs is free software: you can redistribute it and/or modify
|
|
;; it under the terms of the GNU General Public License as published by
|
|
;; the Free Software Foundation, either version 3 of the License, or
|
|
;; (at your option) any later version.
|
|
|
|
;; GNU Emacs is distributed in the hope that it will be useful,
|
|
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
;; GNU General Public License for more details.
|
|
|
|
;; You should have received a copy of the GNU General Public License
|
|
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
;;; Commentary:
|
|
|
|
;; Provides a nice interface to evaluating Emacs Lisp expressions.
|
|
;; Input is handled by the comint package, and output is passed
|
|
;; through the pretty-printer.
|
|
|
|
;; To start: M-x ielm. Type C-h m in the *ielm* buffer for more info.
|
|
|
|
;;; Code:
|
|
|
|
(require 'comint)
|
|
(require 'pp)
|
|
|
|
;;; User variables
|
|
|
|
(defgroup ielm nil
|
|
"Interaction mode for Emacs Lisp."
|
|
:group 'lisp)
|
|
|
|
|
|
(defcustom ielm-noisy t
|
|
"If non-nil, IELM will beep on error."
|
|
:type 'boolean)
|
|
|
|
(defcustom ielm-prompt-read-only t
|
|
"If non-nil, the IELM prompt is read only.
|
|
The read only region includes the newline before the prompt.
|
|
Setting this variable does not affect existing IELM runs.
|
|
This works by setting the buffer-local value of `comint-prompt-read-only'.
|
|
Setting that value directly affects new prompts in the current buffer.
|
|
|
|
If this option is enabled, then the safe way to temporarily
|
|
override the read-only-ness of IELM prompts is to call
|
|
`comint-kill-whole-line' or `comint-kill-region' with no
|
|
narrowing in effect. This way you will be certain that none of
|
|
the remaining prompts will be accidentally messed up. You may
|
|
wish to put something like the following in your init file:
|
|
|
|
\(add-hook \\='ielm-mode-hook
|
|
(lambda ()
|
|
(define-key ielm-map \"\\C-w\" \\='comint-kill-region)
|
|
(define-key ielm-map [C-S-backspace]
|
|
\\='comint-kill-whole-line)))
|
|
|
|
If you set `comint-prompt-read-only' to t, you might wish to use
|
|
`comint-mode-hook' and `comint-mode-map' instead of
|
|
`ielm-mode-hook' and `ielm-map'. That will affect all comint
|
|
buffers, including IELM buffers. If you sometimes use IELM on
|
|
text-only terminals or with `emacs -nw', you might wish to use
|
|
another binding for `comint-kill-whole-line'."
|
|
:type 'boolean
|
|
:version "22.1")
|
|
|
|
(defcustom ielm-prompt "ELISP> "
|
|
"Prompt used in IELM.
|
|
Setting this variable does not affect existing IELM runs.
|
|
|
|
Interrupting the IELM process with \\<ielm-map>\\[comint-interrupt-subjob],
|
|
and then restarting it using \\[ielm], makes the then current
|
|
default value affect _new_ prompts. Unless the new prompt
|
|
differs only in text properties from the old one, IELM will no
|
|
longer recognize the old prompts. However, executing \\[ielm]
|
|
does not update the prompt of an *ielm* buffer with a running process.
|
|
For IELM buffers that are not called `*ielm*', you can execute
|
|
\\[inferior-emacs-lisp-mode] in that IELM buffer to update the value,
|
|
for new prompts. This works even if the buffer has a running process."
|
|
:type 'string)
|
|
|
|
(defvar ielm-prompt-internal "ELISP> "
|
|
"Stored value of `ielm-prompt' in the current IELM buffer.
|
|
This is an internal variable used by IELM. Its purpose is to
|
|
prevent a running IELM process from being messed up when the user
|
|
customizes `ielm-prompt'.")
|
|
|
|
(defcustom ielm-dynamic-return t
|
|
"Controls whether \\<ielm-map>\\[ielm-return] has intelligent behavior in IELM.
|
|
If non-nil, \\[ielm-return] evaluates input for complete sexps, or inserts a newline
|
|
and indents for incomplete sexps. If nil, always inserts newlines."
|
|
:type 'boolean)
|
|
|
|
(defcustom ielm-dynamic-multiline-inputs t
|
|
"Force multiline inputs to start from column zero?
|
|
If non-nil, after entering the first line of an incomplete sexp, a newline
|
|
will be inserted after the prompt, moving the input to the next line.
|
|
This gives more frame width for large indented sexps, and allows functions
|
|
such as `edebug-defun' to work with such inputs."
|
|
:type 'boolean)
|
|
|
|
(defvaralias 'inferior-emacs-lisp-mode-hook 'ielm-mode-hook)
|
|
(defcustom ielm-mode-hook nil
|
|
"Hooks to be run when IELM (`inferior-emacs-lisp-mode') is started."
|
|
:options '(eldoc-mode)
|
|
:type 'hook)
|
|
|
|
;; We define these symbols (that are only used buffer-locally in ielm
|
|
;; buffers) this way to avoid having them be defined in the global
|
|
;; Emacs namespace.
|
|
(defvar *)
|
|
(put '* 'variable-documentation "Most recent value evaluated in IELM.")
|
|
|
|
(defvar **)
|
|
(put '** 'variable-documentation "Second-most-recent value evaluated in IELM.")
|
|
|
|
(defvar ***)
|
|
(put '*** 'variable-documentation "Third-most-recent value evaluated in IELM.")
|
|
|
|
(defvar ielm-match-data nil
|
|
"Match data saved at the end of last command.")
|
|
|
|
;; During IELM evaluation, *1 is the most recent value evaluated in
|
|
;; IELM. Normally identical to `*'. However, if the working buffer
|
|
;; is an IELM buffer, distinct from the process buffer, then `*' gives
|
|
;; the value in the working buffer, `*1' the value in the process
|
|
;; buffer. The intended value is only accessible during IELM
|
|
;; evaluation. *2 and *3 are the same for ** and ***.
|
|
(defvar *1)
|
|
(defvar *2)
|
|
(defvar *3)
|
|
|
|
;;; System variables
|
|
|
|
(defvar ielm-working-buffer nil
|
|
"Buffer in which IELM sexps will be evaluated.
|
|
This variable is buffer-local.")
|
|
|
|
(defvar ielm-header
|
|
(substitute-command-keys
|
|
"*** Welcome to IELM *** Type (describe-mode) or press \
|
|
\\[describe-mode] for help.\n")
|
|
"Message to display when IELM is started.")
|
|
|
|
(defvaralias 'inferior-emacs-lisp-mode-map 'ielm-map)
|
|
(defvar-keymap ielm-map
|
|
:doc "Keymap for IELM mode."
|
|
"TAB" #'ielm-tab
|
|
"RET" #'ielm-return
|
|
"M-RET" #'ielm-return-for-effect
|
|
"C-j" #'ielm-send-input
|
|
"C-M-x" #'eval-defun ; for consistency with
|
|
"M-TAB" #'completion-at-point ; lisp-interaction-mode
|
|
;; These bindings are from `lisp-mode-shared-map' -- can you inherit
|
|
;; from more than one keymap??
|
|
"C-M-q" #'indent-sexp
|
|
"DEL" #'backward-delete-char-untabify
|
|
;; Some convenience bindings for setting the working buffer
|
|
"C-c C-b" #'ielm-change-working-buffer
|
|
"C-c C-f" #'ielm-display-working-buffer
|
|
"C-c C-v" #'ielm-print-working-buffer)
|
|
|
|
(easy-menu-define ielm-menu ielm-map
|
|
"IELM mode menu."
|
|
'("IELM"
|
|
["Change Working Buffer" ielm-change-working-buffer t]
|
|
["Display Working Buffer" ielm-display-working-buffer t]
|
|
["Print Working Buffer" ielm-print-working-buffer t]))
|
|
|
|
(defvar ielm-font-lock-keywords
|
|
'(("\\(^\\*\\*\\*[^*]+\\*\\*\\*\\)\\(.*$\\)"
|
|
(1 font-lock-comment-face)
|
|
(2 font-lock-constant-face)))
|
|
"Additional expressions to highlight in IELM buffers.")
|
|
|
|
;;; Completion stuff
|
|
|
|
(defun ielm-tab ()
|
|
"Indent or complete."
|
|
(interactive)
|
|
(if (or (eq (preceding-char) ?\n)
|
|
(eq (char-syntax (preceding-char)) ?\s))
|
|
(ielm-indent-line)
|
|
(completion-at-point)))
|
|
|
|
|
|
(defun ielm-complete-filename nil
|
|
"Dynamically complete filename before point, if in a string."
|
|
(when (nth 3 (parse-partial-sexp comint-last-input-start (point)))
|
|
(comint-filename-completion)))
|
|
|
|
(defun ielm-indent-line nil
|
|
"Indent the current line as Lisp code if it is not a prompt line."
|
|
(when (save-excursion (comint-bol t) (bolp))
|
|
(lisp-indent-line)))
|
|
|
|
;;; Working buffer manipulation
|
|
|
|
(defun ielm-print-working-buffer nil
|
|
"Print the current IELM working buffer's name in the echo area."
|
|
(interactive)
|
|
(message "The current working buffer is: %s" (buffer-name ielm-working-buffer)))
|
|
|
|
(defun ielm-display-working-buffer nil
|
|
"Display the current IELM working buffer.
|
|
Don't forget that selecting that buffer will change its value of `point'
|
|
to its value of `window-point'!"
|
|
(interactive)
|
|
(display-buffer ielm-working-buffer)
|
|
(ielm-print-working-buffer))
|
|
|
|
(defun ielm-change-working-buffer (buf)
|
|
"Change the current IELM working buffer to BUF.
|
|
This is the buffer in which all sexps entered at the IELM prompt are
|
|
evaluated. You can achieve the same effect with a call to
|
|
`set-buffer' at the IELM prompt."
|
|
(interactive "bSet working buffer to: ")
|
|
(let ((buffer (get-buffer buf)))
|
|
(if (and buffer (buffer-live-p buffer))
|
|
(setq ielm-working-buffer buffer)
|
|
(error "No such buffer: %S" buf)))
|
|
(ielm-print-working-buffer))
|
|
|
|
;;; Other bindings
|
|
|
|
(defun ielm-return (&optional for-effect)
|
|
"Newline and indent, or evaluate the sexp before the prompt.
|
|
Complete sexps are evaluated; for incomplete sexps inserts a newline
|
|
and indents. If however `ielm-dynamic-return' is nil, this always
|
|
simply inserts a newline."
|
|
(interactive)
|
|
(if ielm-dynamic-return
|
|
(let ((state
|
|
(save-excursion
|
|
(end-of-line)
|
|
(parse-partial-sexp (ielm-pm)
|
|
(point)))))
|
|
(if (and (< (car state) 1) (not (nth 3 state)))
|
|
(ielm-send-input for-effect)
|
|
(when (and ielm-dynamic-multiline-inputs
|
|
(save-excursion
|
|
(beginning-of-line)
|
|
(looking-at-p comint-prompt-regexp)))
|
|
(save-excursion
|
|
(goto-char (ielm-pm))
|
|
(newline 1)))
|
|
(newline-and-indent)))
|
|
(newline)))
|
|
|
|
(defun ielm-return-for-effect ()
|
|
"Like `ielm-return', but do not print the result."
|
|
(interactive)
|
|
(ielm-return t))
|
|
|
|
(defvar ielm-input)
|
|
|
|
(defun ielm-input-sender (_proc input)
|
|
;; Just sets the variable ielm-input, which is in the scope of
|
|
;; `ielm-send-input's call.
|
|
(setq ielm-input input))
|
|
|
|
(defun ielm-send-input (&optional for-effect)
|
|
"Evaluate the Emacs Lisp expression after the prompt."
|
|
(interactive)
|
|
(let (ielm-input) ; set by ielm-input-sender
|
|
(comint-send-input) ; update history, markers etc.
|
|
(ielm-eval-input ielm-input for-effect)))
|
|
|
|
;;; Utility functions
|
|
|
|
(defun ielm-is-whitespace-or-comment (string)
|
|
"Return non-nil if STRING is all whitespace or a comment."
|
|
(or (string= string "")
|
|
(string-match-p "\\`[ \t\n]*\\(?:;.*\\)*\\'" string)))
|
|
|
|
;;; Evaluation
|
|
|
|
(defun ielm-standard-output-impl (process)
|
|
"Return a function to use for `standard-output' while in ielm eval.
|
|
The returned function takes one character as input. Passing nil
|
|
to this function instead of a character flushes the output
|
|
buffer. Passing t appends a terminating newline if the buffer is
|
|
nonempty, then flushes the buffer."
|
|
;; Use an intermediate output buffer because doing redisplay for
|
|
;; each character we output is too expensive. Set up a flush timer
|
|
;; so that users don't have to wait for whole lines to appear before
|
|
;; seeing output.
|
|
(let* ((output-buffer nil)
|
|
(flush-timer nil)
|
|
(flush-buffer
|
|
(lambda ()
|
|
(comint-output-filter
|
|
process
|
|
(apply #'string (nreverse output-buffer)))
|
|
(redisplay)
|
|
(setf output-buffer nil)
|
|
(when flush-timer
|
|
(cancel-timer flush-timer)
|
|
(setf flush-timer nil)))))
|
|
(lambda (char)
|
|
(let (flush-now)
|
|
(cond ((and (eq char t) output-buffer)
|
|
(push ?\n output-buffer)
|
|
(setf flush-now t))
|
|
((characterp char)
|
|
(push char output-buffer)))
|
|
(if flush-now
|
|
(funcall flush-buffer)
|
|
(unless flush-timer
|
|
(setf flush-timer (run-with-timer 0.1 nil flush-buffer))))))))
|
|
|
|
(defun ielm-eval-input (input-string &optional for-effect)
|
|
"Evaluate the Lisp expression INPUT-STRING, and pretty-print the result."
|
|
;; This is the function that actually `sends' the input to the
|
|
;; `inferior Lisp process'. All comint-send-input does is works out
|
|
;; what that input is. What this function does is evaluates that
|
|
;; input and produces `output' which gets inserted into the buffer,
|
|
;; along with a new prompt. A better way of doing this might have
|
|
;; been to actually send the output to the `cat' process, and write
|
|
;; this as in output filter that converted sexps in the output
|
|
;; stream to their evaluated value. But that would have involved
|
|
;; more process coordination than I was happy to deal with.
|
|
(let ((string input-string) ; input expression, as a string
|
|
form ; form to evaluate
|
|
pos ; End posn of parse in string
|
|
result ; Result, or error message
|
|
error-type ; string, nil if no error
|
|
(output "") ; result to display
|
|
(wbuf ielm-working-buffer) ; current buffer after evaluation
|
|
(pmark (ielm-pm)))
|
|
(unless (ielm-is-whitespace-or-comment string)
|
|
(condition-case err
|
|
(let ((rout (read-from-string string)))
|
|
(setq form (car rout)
|
|
pos (cdr rout)))
|
|
(error (setq result (error-message-string err))
|
|
(setq error-type "Read error")))
|
|
(unless error-type
|
|
;; Make sure working buffer has not been killed
|
|
(if (not (buffer-name ielm-working-buffer))
|
|
(setq result "Working buffer has been killed"
|
|
error-type "IELM Error"
|
|
wbuf (current-buffer))
|
|
(if (ielm-is-whitespace-or-comment (substring string pos))
|
|
;; To correctly handle the ielm-local variables *,
|
|
;; ** and ***, we need a temporary buffer to be
|
|
;; current at entry to the inner of the next two let
|
|
;; forms. We need another temporary buffer to exit
|
|
;; that same let. To avoid problems, neither of
|
|
;; these buffers should be alive during the
|
|
;; evaluation of form.
|
|
(let* ((*1 (bound-and-true-p *))
|
|
(*2 (bound-and-true-p **))
|
|
(*3 (bound-and-true-p ***))
|
|
(active-process (ielm-process))
|
|
(old-standard-output standard-output)
|
|
new-standard-output
|
|
ielm-temp-buffer)
|
|
(set-match-data ielm-match-data)
|
|
(save-excursion
|
|
(with-temp-buffer
|
|
(condition-case-unless-debug err
|
|
(unwind-protect
|
|
;; The next let form creates default
|
|
;; bindings for *, ** and ***. But
|
|
;; these default bindings are
|
|
;; identical to the ielm-local
|
|
;; bindings. Hence, during the
|
|
;; evaluation of form, the
|
|
;; ielm-local values are going to be
|
|
;; used in all buffers except for
|
|
;; other ielm buffers, which override
|
|
;; them. Normally, the variables *1,
|
|
;; *2 and *3 also have default
|
|
;; bindings, which are not overridden.
|
|
(let ((* *1)
|
|
(** *2)
|
|
(*** *3))
|
|
(when (eq standard-output t)
|
|
(setf new-standard-output
|
|
(ielm-standard-output-impl
|
|
active-process))
|
|
(setf standard-output new-standard-output))
|
|
(kill-buffer (current-buffer))
|
|
(set-buffer wbuf)
|
|
(setq result
|
|
(eval form lexical-binding))
|
|
(setq wbuf (current-buffer))
|
|
(setq
|
|
ielm-temp-buffer
|
|
(generate-new-buffer " *ielm-temp*"))
|
|
(set-buffer ielm-temp-buffer))
|
|
(when ielm-temp-buffer
|
|
(kill-buffer ielm-temp-buffer))
|
|
(when (eq new-standard-output standard-output)
|
|
(ignore-errors
|
|
(funcall standard-output t))
|
|
(setf standard-output old-standard-output)))
|
|
(error (setq result (error-message-string err))
|
|
(setq error-type "Eval error"))
|
|
(quit (setq result "Quit during evaluation")
|
|
(setq error-type "Eval error")))))
|
|
(setq ielm-match-data (match-data)))
|
|
(setq error-type "IELM error")
|
|
(setq result "More than one sexp in input"))))
|
|
|
|
;; If the eval changed the current buffer, mention it here
|
|
(unless (eq wbuf ielm-working-buffer)
|
|
(message "current buffer is now: %s" wbuf)
|
|
(setq ielm-working-buffer wbuf))
|
|
|
|
(goto-char pmark)
|
|
(unless error-type
|
|
(condition-case err
|
|
;; Self-referential objects cause loops in the printer, so
|
|
;; trap quits here. May as well do errors, too
|
|
(unless for-effect
|
|
(let* ((ielmbuf (current-buffer))
|
|
(aux (let ((str (eval-expression-print-format result)))
|
|
(if str (propertize str 'font-lock-face 'shadow)))))
|
|
(setq output (with-temp-buffer
|
|
(let ((tmpbuf (current-buffer)))
|
|
;; Use print settings (e.g. print-circle,
|
|
;; print-gensym, etc...) from the
|
|
;; right buffer!
|
|
(with-current-buffer ielmbuf
|
|
(cl-prin1 result tmpbuf))
|
|
(pp-buffer)
|
|
(concat (buffer-string) aux))))))
|
|
(error
|
|
(setq error-type "IELM Error")
|
|
(setq result (format "Error during pretty-printing: %S" err)))
|
|
(quit (setq error-type "IELM Error")
|
|
(setq result "Quit during pretty-printing"))))
|
|
(if error-type
|
|
(progn
|
|
(when ielm-noisy (ding))
|
|
(setq output (concat output
|
|
"*** " error-type " *** "
|
|
result)))
|
|
;; There was no error, so shift the *** values
|
|
(setq *** (bound-and-true-p **))
|
|
(setq ** (bound-and-true-p *))
|
|
(setq * result))
|
|
(when (or (not for-effect) (not (equal output "")))
|
|
(setq output (concat output "\n"))))
|
|
(setq output (concat output ielm-prompt-internal))
|
|
(comint-output-filter (ielm-process) output)))
|
|
|
|
;;; Process and marker utilities
|
|
|
|
(defun ielm-process nil
|
|
;; Return the current buffer's process.
|
|
(get-buffer-process (current-buffer)))
|
|
|
|
(defun ielm-pm nil
|
|
;; Return the process mark of the current buffer.
|
|
(process-mark (get-buffer-process (current-buffer))))
|
|
|
|
(defun ielm-set-pm (pos)
|
|
;; Set the process mark in the current buffer to POS.
|
|
(set-marker (process-mark (get-buffer-process (current-buffer))) pos))
|
|
|
|
;;; Input fontification
|
|
|
|
(defcustom ielm-fontify-input-enable t
|
|
"Enable fontification of input in ielm buffers.
|
|
This variable only has effect when creating an ielm buffer. Use
|
|
the command `comint-fontify-input-mode' to toggle fontification
|
|
of input in an already existing ielm buffer."
|
|
:type 'boolean
|
|
:safe 'booleanp
|
|
:version "29.1")
|
|
|
|
(defcustom ielm-indirect-setup-hook nil
|
|
"Hook run in an indirect buffer for input fontification.
|
|
Input fontification and indentation of an IELM buffer, if
|
|
enabled, is performed in an indirect buffer, whose indentation
|
|
and syntax highlighting are set up with `emacs-lisp-mode'. In
|
|
addition to `comint-indirect-setup-hook', run this hook with the
|
|
indirect buffer as the current buffer after its setup is done.
|
|
This can be used to further customize fontification and other
|
|
behavior of the indirect buffer."
|
|
:type 'boolean
|
|
:safe 'booleanp
|
|
:version "29.1")
|
|
|
|
(defun ielm-indirect-setup-hook ()
|
|
"Run `ielm-indirect-setup-hook'."
|
|
(run-hooks 'ielm-indirect-setup-hook))
|
|
|
|
;;; Major mode
|
|
|
|
(define-derived-mode inferior-emacs-lisp-mode comint-mode "IELM"
|
|
"Major mode for interactively evaluating Emacs Lisp expressions.
|
|
Uses the interface provided by `comint-mode' (which see).
|
|
|
|
* \\<ielm-map>\\[ielm-send-input] evaluates the sexp following the prompt. There must be at most
|
|
one top level sexp per prompt.
|
|
|
|
* \\[ielm-return] inserts a newline and indents, or evaluates a
|
|
complete expression (but see variable `ielm-dynamic-return').
|
|
Inputs longer than one line are moved to the line following the
|
|
prompt (but see variable `ielm-dynamic-multiline-inputs').
|
|
|
|
* \\[ielm-return-for-effect] works like `ielm-return', except
|
|
that it doesn't print the result of evaluating the input. This
|
|
functionality is useful when forms would generate voluminous
|
|
output.
|
|
|
|
* \\[completion-at-point] completes Lisp symbols (or filenames, within strings),
|
|
or indents the line if there is nothing to complete.
|
|
|
|
The current working buffer may be changed (with a call to `set-buffer',
|
|
or with \\[ielm-change-working-buffer]), and its value is preserved between successive
|
|
evaluations. In this way, expressions may be evaluated in a different
|
|
buffer than the *ielm* buffer. By default, its name is shown on the
|
|
mode line; you can always display it with \\[ielm-print-working-buffer], or the buffer itself
|
|
with \\[ielm-display-working-buffer].
|
|
|
|
During evaluations, the values of the variables `*', `**', and `***'
|
|
are the results of the previous, second previous and third previous
|
|
evaluations respectively. If the working buffer is another IELM
|
|
buffer, then the values in the working buffer are used. The variables
|
|
`*1', `*2' and `*3', yield the process buffer values.
|
|
|
|
If, at the start of evaluation, `standard-output' is t (the
|
|
default), `standard-output' is set to a special function that
|
|
causes output to be directed to the ielm buffer.
|
|
`standard-output' is restored after evaluation unless explicitly
|
|
set to a different value during evaluation. You can use (princ
|
|
VALUE) or (pp VALUE) to write to the ielm buffer.
|
|
|
|
The behavior of IELM may be customized with the following variables:
|
|
* To stop beeping on error, set `ielm-noisy' to nil.
|
|
* If you don't like the prompt, you can change it by setting `ielm-prompt'.
|
|
* If you do not like that the prompt is (by default) read-only, set
|
|
`ielm-prompt-read-only' to nil.
|
|
* Set `ielm-dynamic-return' to nil for bindings like `lisp-interaction-mode'.
|
|
* Entry to this mode runs `comint-mode-hook' and `ielm-mode-hook'
|
|
(in that order).
|
|
|
|
Customized bindings may be defined in `ielm-map', which currently contains:
|
|
\\{ielm-map}"
|
|
:syntax-table emacs-lisp-mode-syntax-table
|
|
:after-hook
|
|
(and (null comint-use-prompt-regexp)
|
|
ielm-fontify-input-enable
|
|
(comint-fontify-input-mode))
|
|
|
|
(setq comint-prompt-regexp (concat "^" (regexp-quote ielm-prompt)))
|
|
(setq-local paragraph-separate "\\'")
|
|
(setq-local paragraph-start comint-prompt-regexp)
|
|
(setq comint-input-sender 'ielm-input-sender)
|
|
(setq comint-process-echoes nil)
|
|
(dolist (f '(elisp-completion-at-point
|
|
ielm-complete-filename
|
|
comint-replace-by-expanded-history))
|
|
(add-hook 'completion-at-point-functions f nil t))
|
|
(add-hook 'eldoc-documentation-functions
|
|
#'elisp-eldoc-var-docstring nil t)
|
|
(add-hook 'eldoc-documentation-functions
|
|
#'elisp-eldoc-funcall nil t)
|
|
(setq-local ielm-prompt-internal ielm-prompt)
|
|
(setq-local comint-prompt-read-only ielm-prompt-read-only)
|
|
(setq comint-get-old-input 'ielm-get-old-input)
|
|
(setq-local comint-completion-addsuffix '("/" . ""))
|
|
(setq mode-line-process '(":%s on " (:eval (buffer-name ielm-working-buffer))))
|
|
;; Useful for `hs-minor-mode'.
|
|
(setq-local comment-start ";")
|
|
(setq-local comment-use-syntax t)
|
|
(setq-local lexical-binding t)
|
|
|
|
(setq-local indent-line-function #'ielm-indent-line)
|
|
(setq-local ielm-working-buffer (current-buffer))
|
|
(setq-local fill-paragraph-function #'lisp-fill-paragraph)
|
|
|
|
;; Value holders
|
|
(setq-local * nil)
|
|
(setq-local ** nil)
|
|
(setq-local *** nil)
|
|
(setq-local ielm-match-data nil)
|
|
|
|
;; font-lock support
|
|
(setq-local font-lock-defaults
|
|
'(ielm-font-lock-keywords nil nil ((?: . "w") (?- . "w") (?* . "w"))))
|
|
|
|
(add-hook 'comint-indirect-setup-hook
|
|
#'ielm-indirect-setup-hook 'append t)
|
|
(setq comint-indirect-setup-function #'emacs-lisp-mode)
|
|
|
|
;; A dummy process to keep comint happy. It will never get any input
|
|
(unless (comint-check-proc (current-buffer))
|
|
;; Was cat, but on non-Unix platforms that might not exist, so
|
|
;; use hexl instead, which is part of the Emacs distribution.
|
|
(condition-case nil
|
|
(start-process "ielm" (current-buffer) "hexl")
|
|
(file-error (start-process "ielm" (current-buffer) "cat")))
|
|
(set-process-query-on-exit-flag (ielm-process) nil)
|
|
(goto-char (point-max))
|
|
|
|
;; Lisp output can include raw characters that confuse comint's
|
|
;; carriage control code.
|
|
(setq-local comint-inhibit-carriage-motion t)
|
|
|
|
;; Add a silly header
|
|
(insert ielm-header)
|
|
(ielm-set-pm (point-max))
|
|
(unless comint-use-prompt-regexp
|
|
(let ((inhibit-read-only t))
|
|
(add-text-properties
|
|
(point-min) (point-max)
|
|
'(rear-nonsticky t field output inhibit-line-move-field-capture t))))
|
|
(comint-output-filter (ielm-process) ielm-prompt-internal)
|
|
(set-marker comint-last-input-start (ielm-pm))
|
|
(set-process-filter (get-buffer-process (current-buffer)) 'comint-output-filter)))
|
|
|
|
(defun ielm-get-old-input nil
|
|
;; Return the previous input surrounding point
|
|
(save-excursion
|
|
(beginning-of-line)
|
|
(unless (looking-at-p comint-prompt-regexp)
|
|
(re-search-backward comint-prompt-regexp))
|
|
(comint-skip-prompt)
|
|
(buffer-substring (point) (progn (forward-sexp 1) (point)))))
|
|
|
|
;;; User command
|
|
|
|
;;;###autoload
|
|
(defun ielm (&optional buf-name)
|
|
"Interactively evaluate Emacs Lisp expressions.
|
|
Switches to the buffer named BUF-NAME if provided (`*ielm*' by default),
|
|
or creates it if it does not exist.
|
|
See `inferior-emacs-lisp-mode' for details."
|
|
(interactive)
|
|
(let (old-point
|
|
(buf-name (or buf-name "*ielm*")))
|
|
(unless (comint-check-proc buf-name)
|
|
(with-current-buffer (get-buffer-create buf-name)
|
|
(unless (zerop (buffer-size)) (setq old-point (point)))
|
|
(inferior-emacs-lisp-mode)))
|
|
(pop-to-buffer-same-window buf-name)
|
|
(when old-point (push-mark old-point))))
|
|
|
|
(provide 'ielm)
|
|
|
|
;;; ielm.el ends here
|