77e4cc4d58
:feature was a "catch-all" category. Many of its modules fit better in other categories, so they've been moved: - feature/debugger -> tools/debugger - feature/evil -> editor/evil - feature/eval -> tools/eval - feature/lookup -> tools/lookup - feature/snippets -> editor/snippets - feature/file-templates -> editor/file-templates - feature/workspaces -> ui/workspaces More potential changes in the future: - A new :term category for terminal emulation modules (eshell, term and vterm). - A new :os category for modules dedicated to os-specific functionality. The :tools macos module would fit here, but so would modules for nixos and arch. - A new :services category for web-service integration, like wakatime, twitter, elfeed, gist and pastebin services.
117 lines
3.7 KiB
Org Mode
117 lines
3.7 KiB
Org Mode
#+TITLE: tools/eval
|
|
#+DATE: February 13, 2017
|
|
#+SINCE: v2.0
|
|
#+STARTUP: inlineimages
|
|
|
|
* Table of Contents :TOC_3:noexport:
|
|
- [[Description][Description]]
|
|
- [[Module Flags][Module Flags]]
|
|
- [[Plugins][Plugins]]
|
|
- [[Hacks][Hacks]]
|
|
- [[Prerequisites][Prerequisites]]
|
|
- [[Features][Features]]
|
|
- [[Inline Code Evaluation][Inline Code Evaluation]]
|
|
- [[REPLs][REPLs]]
|
|
- [[Configuration][Configuration]]
|
|
- [[Register a REPL for a major-mode][Register a REPL for a major-mode]]
|
|
- [[Change how code is evaluated in a major mode][Change how code is evaluated in a major mode]]
|
|
- [[Troubleshooting][Troubleshooting]]
|
|
|
|
* Description
|
|
This modules adds inline code evaluation support to Emacs, and supplies a
|
|
universal interface for opening and interacting with REPLs.
|
|
|
|
** Module Flags
|
|
This module has no flags.
|
|
|
|
** Plugins
|
|
+ [[https://github.com/syohex/emacs-quickrun][quickrun]]
|
|
|
|
** Hacks
|
|
+ Quickrun has been modified to:
|
|
+ Use only one output window, in case of consecutive execution of code.
|
|
+ The quickrun window will resize itself to fit its output, once the
|
|
underlying process is finished executing the code.
|
|
|
|
* Prerequisites
|
|
This module has no direct prerequisites.
|
|
|
|
However, specific languages may require additional setup. Check the
|
|
documentation of that language's module for details.
|
|
|
|
* Features
|
|
** Inline 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.
|
|
|
|
** REPLs
|
|
Invoked via:
|
|
+ =SPC o r= or ~:repl~ will open a REPL in a popup window. =C-u SPC o r= or
|
|
~:repl!~ will open a REPL in the current window. If a REPL is already open and
|
|
a selection is active, it will be sent to the REPL.
|
|
+ ~M-x +eval/open-repl-other-window~
|
|
+ ~M-x +eval/open-repl-same-window~
|
|
+ ~M-x +eval/send-region-to-repl~ while a selection (and REPL) is active
|
|
|
|
* Configuration
|
|
** Register a REPL for a major-mode
|
|
REPLs are defined for most languages Doom supports. Check that language module's
|
|
README.org to see if it does (and if it requires additional setup).
|
|
|
|
To use them, you may use ~M-x +eval/open-repl-other-window~, ~M-x
|
|
+eval/open-repl-same-window~, ~:repl~ (for evil users) or the default binding:
|
|
=SPC o r=. These will open a REPL in a popup window.
|
|
|
|
#+begin_quote
|
|
You can simply call that mode's REPL command manually. e.g. ~M-x ielm~, but
|
|
#+end_quote
|
|
|
|
Otherwise, you can define your own for a specified major mode:
|
|
|
|
~(set-repl-handler! MAJOR-MODE FUNCTION)~
|
|
|
|
FUNCTION should return a repl buffer. Any window changes in this function are
|
|
ignored, then the REPL is opened in a popup window.
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(defun +lua/open-repl ()
|
|
(interactive)
|
|
(lua-start-process "lua" "lua")
|
|
(pop-to-buffer lua-process-buffer))
|
|
|
|
(set-repl-handler! 'lua-mode #'+lua/open-repl)
|
|
#+END_SRC
|
|
|
|
** Change how code is evaluated in a major mode
|
|
Run regions or entire buffers with [[https://github.com/syohex/emacs-quickrun][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 [[https://crystal-lang.org/][Crystal]]), or a language with better Emacs integration
|
|
(like elisp).
|
|
|
|
Here's how you define a "runner":
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(set-eval-handler! 'crystal-mode
|
|
'((:command . "crystal")
|
|
(:exec . "%c %s")
|
|
(:description . "Run Crystal script")))
|
|
#+END_SRC
|
|
|
|
A simpler version is simply to use the path to the binary:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(set-eval-handler! 'groovy-mode "groovy")
|
|
#+END_SRC
|
|
|
|
Or if you'd rather run an elisp command:
|
|
|
|
#+BEGIN_SRC emacs-lisp
|
|
(set-eval-handler! 'emacs-lisp-mode #'+emacs-lisp-eval)
|
|
#+END_SRC
|
|
|
|
* Troubleshooting
|