History

Edwin Török b9c966ec54 Backport to Emacs 25: avoid (setf (alist-get ... 'equal)) We would need to use `'equal` for comparison, but Emacs 25 only allows `'eq`. Using `advice-add` to override `alist-get` does not work, because `setf` has special handling for `alist-get`. `repl.el`: Switch to a hash table which already supports multiple comparison functions, and changing of elements even in Emacs 25. `eshell/autoload/settings.el`: use conditional set-or-push. Drop `doom*alist-get`, it is unused now. Thanks to @hlissner for the reimplementation.		2018-09-12 23:03:02 +01:00
..
autoload	Backport to Emacs 25: avoid (setf (alist-get ... 'equal))	2018-09-12 23:03:02 +01:00
config.el	Remove third line in section headers	2018-09-09 09:58:19 -04:00
packages.el	feature/eval: rewrite module	2017-03-04 18:29:55 -05:00
README.org	Update & reformat module readmes for v2.0.9	2018-01-01 13:21:53 -05:00

README.org

:feature eval

Table of Contents
Install
Usage
- REPLs
- Code Evaluation
Configuration
- REPLs
- Code Evaluation

This modules adds support for evaluating code from inside Emacs, including REPLs.

Install

This module has no external dependencies. However, specific languages may require additional setup.

Check the README.org in that language's module for details.

Usage

REPLs

Invoked via:

:repl (evil ex-command)
<leader> o r in normal mode (or visual mode, which sends the selection to the open REPL)
M-x +eval/open-repl
M-x +eval/send-region-to-repl while a selection (and REPL) is active

Code Evaluation

Quickrun can be invoked via:

M-x +eval/buffer (or gR, or M-r)
M-x +eval/region
M-x +eval/region-and-replace
Evil users can use the gr operator to select and run a region.

Configuration

REPLs

REPLs are defined for most of the languages Doom supports (check its README.org to see if it does).

Otherwise, you can define your own for a specified major-mode with the :repl setting.

(set! :repl MAJOR-MODE FUNCTION)

FUNCTION must return the repl buffer. Any window changes are ignored, then handed off to shackle (assuming shackle-mode is on) to display in a popup window.

(defun +emacs-lisp/repl ()
  (interactive)
  (pop-to-buffer
   (or (get-buffer "*ielm*")
       (progn (ielm)
              (let ((buf (get-buffer "*ielm*")))
                (bury-buffer buf)
                buf)))))

(set! :repl 'emacs-lisp-mode #'+emacs-lisp/repl)

Code Evaluation

Run regions or entire buffers with Quickrun. Output is show in a popup window.

Quickrun includes support for many languages, usually by sending text directly to interpreters or compilers. However, occasionally, you'll find a language without support (like Crystal), or a language with better Emacs integration (like elisp).

Here's how you define a "runner":

(set! :eval 'crystal-mode
      '((:command     . "crystal")
        (:exec        . "%c %s")
        (:description . "Run Crystal script")))

A simpler version is simply to use the path to the binary:

(set! :eval 'groovy-mode "groovy")

Or if you'd rather run an elisp command:

(set! :eval 'emacs-lisp-mode #'+emacs-lisp-eval)