Note: Portacle is a portable and multiplatform CL development environment, a straightforward way to get going.
Why Use Emacs?
- Emacs has fantastic support for working with Lisp code
- Not tying yourself into a single CL vendor’s editor
- Runs on virtually every OS and CL implementation
- Extensible: awesome-emacs.
- Can be customized to do many common tasks
- Built-in support for different source code version control systems
- Vast number of add-on packages
- Emacs will probably always be around
- Emacs works well either with a mouse or without a mouse
- Emacs has a large user base with multiple newsgroups
- Benefits of using Emacs far outweigh the effort spent in learning it
- Because Emacs Rocks !
Emacs Lisp vs Common Lisp
- Learning Emacs Lisp is useful and similar (but different from CL):
- Dynamic scope is everywhere
- There are no reader (or reader-related) functions
- Does not support all the types that are supported in CL
- Incomplete implementation of CLOS (with the add-on EIEIO package)
- Not all of CL is supported
- No numerical tower support
- Some good Emacs Lisp learning resources:
SLIME: Superior Lisp Interaction Mode for Emacs
SLIME is the goto major mode for CL programming.
- Provides REPL which is hooked to implementation directly in Emacs
- Has integrated Common Lisp debugger with Emacs interface
- Interactive object-inspector in Emacs buffer
- Has its own minor mode which enhances lisp-mode in many ways
- Supports every common Common Lisp implementation
- Readily available from MELPA
- Actively maintained
- Symbol completion
- Can perform macroexpansions
- Installing SLIME without MELPA can be tricky
- Installing it from MELPA is straightforward. Search package-list-packages for ‘slime’ and click to install. If MELPA is configured correctly, it will install itself and all dependencies.
- Enable the desired contribs (SLIME does very little by defaults), e.g.
(slime-setup '(slime-fancy slime-quicklisp slime-asdf)).
- Run SLIME with
Check out this video tutorial ! (and the author’s channel, full of great stuff)
SLIME also has some nice extensions like Helm-SLIME which features, among others
- Fuzzy completion,
- REPL and connection listing,
- Fuzzy-search of the REPL history,
- Fuzzy-search of the apropos documentation.
From the SLIME REPL, press
, to prompt for commands. There is completion
over the available systems and packages. Examples:
and many more.
slime-quicklisp contrib, you can also
,ql to list all systems
available for installation.
SLY: Sylvester the Cat’s Common Lisp IDE
SLY is a SLIME fork that contains the following improvements:
- Completely redesigned REPL based on Emacs’s own full-featured comint.el
- Live code annotations via a new sly-stickers contrib
- Consistent interactive button interface. Everything can be copied to the REPL.
- Multiple inspectors with independent history
- Regexp-capable M-x sly-apropos
- Contribs are first class SLY citizens, enabled by default, loaded with ASDF on demand.
- Support for NAMED-READTABLES, macrostep.el and quicklisp.
Working with Lisp Code
In this short tutorial we’ll see how to:
- edit Lisp code
- evaluate and compile Lisp code
- search Lisp code
- Note: Example code assumes you are using a setup similar to what is defined in the .emacs file from the CL Cookbook site.
Packages for structured editing
In addition to the built-in Emacs commands, you have several packages at your disposal that will help to keep the parens and/or the indentation balanced. The list below is somewhat sorted by age of the extension, according to the history of Lisp editing:
- Paredit - Paredit is a classic. It defines the must-have commands (move, kill, split, join a sexp,…). (visual tutorial)
- Smartparens - Smartparens not only deals with parens but with everything that comes in pairs (html tags,…) and thus has features for non-lispy languages.
- Lispy - Lispy reimagines Paredit with the goal to have the shortest bindings (mostly one key) that only act depending on the point position.
- Paxedit - Paxedit adds commands based on the context (in a symbol, a sexp,… ) and puts efforts on whitespace cleanup and context refactoring.
- Parinfer - Parinfer automatically fixes the parens depending on the indentation, or the other way round (or both !).
We personnaly advice to try Parinfer and the famous Paredit, then to go up the list. See explanations and even more on Wikemacs.
Forward/Backward/Up/Down movement and selection by s-expressions
;; Put the cursor on the open parens of "(defvar.." and press "C-M-f" ;; and "C-M-b" a few times to see how you move in units of sexps. Put ;; the cursor on the second additon in the "(progn" statement and ;; press "C-M-t" to swap the first addition sexp and the second ;; one. Put the cursor on the open parens of "(+ x" in defun c and ;; press "C-M-@" to highlight the entire sexp. Then press "C-M-u" to ;; expand the selection "upwards" to the enclosing "(let". Pressing ;; "C-M-d" moves to the next enclosed sexp or (if you are at the ;; beginning of a line) to the enclosed sexp on the line: (defvar a "a variable") (defun b () "a function" (+ 2 2)) (defun c () "another function" (let ((x 42)) (+ x (+ 2 2) (+ 3 3) (+ 4 4)))) (progn (+ 1 1) (+ 2 2) (+ 3 3))
C-M-backspace (which may restart the system on gnu/linux):
;; Put the cursor on the open parens of "(progn .." and press "C-M-k" ;; to delete it. Then press "C-M-backspace" to delete the sexp before ;; the cursor (caution, on gnu/linux this keybinding may mean to ;; restart the system): (defun d () (if t (+ 3 3) (progn (+ 1 1) (if t (+ 2 2) (+ 3 3))) (+ 4 4)))
;; Put the cursor on the open parens of "(defun ..." and press "C-M-q" ;; to indent the code: (defun e () "A badly indented function." (let ((x 20)) (loop for i from 0 to x do (loop for j from 0 below 10 do (print j)) (if (< i 10) (let ((z nil) ) (setq z (format t "x=~d" i)) (print z)))))) ;; This is the result: (defun e () "A badly indented function." (let ((x 20)) (loop for i from 0 to x do (loop for j from 0 below 10 do (print j)) (if (< i 10) (let ((z nil) ) (setq z (format t "x=~d" i)) (print z))))))
Support for parenthesis
M-( insets a pair,
M-x check-parens to spot malformed sexps,
C-u <n> M-( to enclose sexps with parens:
;; Placing the cursor on a "(" or after a ")" highlights the matching ;; parens: (progn (+ 3 3) (- 2 2)) ;; A mismatched parens is highlighted in a different color (put cursor ;; after last parens and enter a ")" to see this: (- 2 2) ;; You can also type "M-x check-parens" to locate mismatched parens in ;; a buffer ;; Press "M-(" and you will get: () ;; with the cursor placed on the closing parens, ready to enter the ;; function name. ;; Put the cursor on the open parens of the "(+ 2 2)" sexp below and ;; press "C-u 2 M-(" to enclose the next 2 sexps with parens - then ;; type "+ 1" to add "1" to the result of the following 2 sexps: (progn (+ 2 2) (+ 3 3)) ;; To delete the enclosing "progn" below, put the cursor on the open ;; parens of the "(+ 1 1)" and press the following sequence of keys: ;; "C-M-k C-M-k C-M-k C-M-u C-M-k C-y M-y C-M-a C-M-q": (defun a () (progn (+ 1 1) (+ 2 2) (+ 3 3)))
Automatic code indentation
;; Indentation is automatic for Lisp forms. Example: Put the cursor ;; after the first addition form and press Enter: (progn (+ 3 3) (- 2 2)) ;; Pressing TAB will indent incorrectly indented code. Example: Put ;; the cursor at the beginning of the "(+ 3 3)" form and press TAB: (progn (+ 3 3)) ;; CL indentation rules are different from Emacs Lisp indentation ;; rules. Make certain you have the following code in a lisp mode hook ;; in your .emacs file: (set (make-local-variable lisp-indent-function) 'common-lisp-indent-function)
Use the built-in
C-c TAB to complete symbols in SLIME. You can get tooltips
;; The Emacs hippie-expand command will expand lisp symbols ;; (however, it only works off of lisp symbol information that is ;; either available in the buffers or a standard CL symbol) and ;; directories. For example, type in the following and press "C-c /" ;; to get a directory completion: (setq x "c:/pro
C-x n n (narrow) and
C-x n w to widen back.
See also code folding.
;; Highlight the middle "(if ..." block and press "C-x n n" to hide ;; everything but that block ("C-x n w" restores the other code): (if a (+ 1 1)) (if b (+ 2 2)) (if c (+ 3 3)) ;; Put the cursor on "(defun b ..." and press "C-x n d" to narrow to ;; just defun b (("C-x n w" restores the other code): (defun a () (+ 1 1)) (defun b () (+ 2 2)) (defun c () (+ 3 3))
Insert a comment, comment a region with
M-;, adjust text with
;; Put the cursor on the following sexp and press "M-;" to get a ;; code line comment (right-hand comment): (setq x 1) ;; Highlight the 2nd & 3rd lines and press "M-;" to comment out those ;; lines (highlighting them a 2nd time and pressing "M-;" removes the ;; comment): (+ 1 1) (+ 2 2) (+ 3 3) ;; Using Paul Foley's comment functions allows you to selectively ;; comment out embedded sexps. Example: Put the cursor on the "(+ 4 ;; 4)" sexp and press "C-c ;" to comment out that sexp. Pressing "C-c ;; ;" comments out the enclosing sexp (and on upwards). Pressing "C-c ;; :" removes the comment: (+ 1 (+ 2 (+ 3 (+ 4 4)))) ;; Emacs knows how to wrap comment text intelligently. For example, this comment line spans ;; muliple lines but is not aligned consitently ;; with the rest of the comments/code in the file (everything else ;; ends at ;; column 68. Pressing "M-q" adjusts the comments appropriately.
Evaluating and Compiling Lisp in SLIME
Compile the entire buffer by pressing
Compile a region by selecting the first 2 forms in test-all and
Compile a defun by putting the cursor inside the “test-format”
defun and pressing
Compile the sexp before the point by putting the cursor after the
closing paren of
(test-format) and pressing
To evaluate rather than compile:
- evaluate a region with
- evaluate a defun with
- evaluate the sexp before the point with
C-x C-e. See also other commands in the menu.
Searching Lisp Code
Standard Emacs text search (isearch forward/backward, regexp searches, search/replace)
C-s does an incremental search forward (e.g. - as each key is
the search string is entered, the source file is searched for the
first match. This can make finding specific text much quicker as
you only need to type in the unique characters. Repeat searches
(using the same search characters) can be done by repeatedly
C-r does an incremental search backward
C-s RET and
C-r RET both do conventional string searches
(forward and backward respectively)
C-M-r both do regular expression searches (forward
and backward respectively)
M-% does a search/replace while
C-M-% does a regular
Finding occurences (occur, grep)
;; Use the Emacs "occur" function to find all occurances of a string ;; (or regexp) in a buffer. Example: Enter "M-x occur" and enter the ;; string "defun" to get a list of all the occurances of the ;; characters "defun" in the current buffer. (defvar aa "a" "a variable") (defun b () "a function" (+ 2 2)) (defun c () "another function" (+ 3 3)) (defmacro d (x) "a macro" `(list ,x)) ;; Use the Emacs "grep" function to find all occurances of a string ;; (or regexp) in a multiple files. Example: Enter "M-x grep" and ;; enter the string "defun *.lisp" to get a list of all the function ;; definitions in lisp files in the current directory.
Lisp symbols in current source (imenu)
;; Open a lisp source file and press the middle mouse button for a ;; pop-up window listing all variables and functions in the lisp ;; source file.
See also helm-imenu and imenu-anywhere.
Go to definition
Put the cursor on any symbol and press
M-. to go to its
M-, to come back.
Find who’s calling, referencing, setting a symbol
See SLIME’s help menu. You can search and list “who” is calling, referencing, setting, binding, macroexpanding symbols, and more.
Lisp symbols in multiple source files (etags)
;; Enter "M-x shell" to bring up a shell window in the current ;; directory. Then run "etags *.lisp" to create a TAG file containing ;; all symbols in lisp files in the current directory. Then run "etags ;; -a subdir/*.lisp" to add to the TAG file symbols from all lisp ;; files in another directory. Locate the definition of the "aa" ;; variable is the s13.lisp file by putting the cursor on the "aa" in ;; the following form and pressing "M-.". (setq x aa)
;; Press "M-x ecb-activate" to start up ECB. Load a lisp file by ;; pressing the middle mouse button (or the Enter key) on any file ;; name in the ECB mini-window. Pressing the middle mouse button (or ;; the Enter key) on any definition in the ECB symbol mini-window ;; takes you to that definition. Press "C-F7" to toggle between full ;; screen and ECB views.
Lisp Documentation in Emacs - Learning About Lisp Symbols
When you put the cursor on a function, SLIME will show its signature in the minibuffer.
;; Enter and evaluate the following definitions, then put the cursor ;; on "(xx)" and press "C-c C-d d" to get the function documentation. (defun xx () "A do-nothing function" nil) (setf (documentation 'xx 'function) "A function that does nil.") (xx)
;; Enter and evaluate the following definitions, then put the cursor ;; on "(xx)" and press "C-c I" or "C-c C-v C-i" (SLIME) to execute "inspect" on ;; the "xx" function. Entering "h" gives a list of help commands and ;; "q" exits the inspector. (defun xx () "A do-nothing function" nil) (setf (documentation 'xx 'function) "A function that does nil.") (xx)
;; Enter the following function definition, then put the cursor on the ;; open parens of "(defun ..." and call "M-x slime-macro-expand-1" to ;; get a macroexpand-1. Then press "C-c M-m" to get a recursive ;; macroexpansion. See also the menu. (defun test (n) (loop for i from 0 below n do (print i)))
Lisp Documentation in Emacs - Lisp Documentation
;; Put the cursor on the "(format" below and press "C-c C-d d" or "F1" ;; with the example emacs configuration to get the Hyperspec page for ;; "format". Put the cursor on the "d" in the format string and press ;; "C-u F1" to get the Hyperspec page describing the "Tilde D: ;; Decimal" format character. (format t "One = ~d" 1) ;; Note: Depending on the documentation packages that have been ;; loaded, and the browser that you wish to use, the following keys ;; may be used: ;; Default W3 ;; Package Browser Browser Format-Dft Format-W3 Info ;; ========= ======= ======= ========== ========= ==== ;; Hyperspec F1 S-F1 C-u F1 C-u S-F1 ;; CLtL2 M-F1 M-S-F1 ;; ACL docs C-F1 C-S-F1 ;; Info docs C-M-F1
Consult the CLHS offline
Then add this to your Emacs configuration:
(load "~/.quicklisp/clhs-use-local.el" 'noerror)
Send to the REPL
;; With the cursor on the "let", press "C-x C-e" (Slime) to ;; evaluate a lisp form by sending it to the REPL. (let ((n 20)) (loop for i from 0 below n do (print i)))
See also eval-in-repl to send any form to the repl.
ASDF is the de-facto build facility. It is shipped in most Common Lisp implementations.
Comparing versions of code (ediff)
Start the ediff utility by entering
M-x ediff. Enter two file names, press
the space bar to step through the changes, and
Of course, see also magit for a wonderful git integration into Emacs.
You might want to set this to your init file:
(set-language-environment "UTF-8") (setenv "LC_CTYPE" "en_US.UTF-8")
and for Sly:
(setq sly-lisp-implementations '((sbcl ("/usr/local/bin/sbcl") :coding-system utf-8-unix) ))
This will avoid getting
ascii stream decoding errors when you have
non-ascii characters in files you evaluate with SLIME.
I switch between UNIX® and Windows environments and, although Emacs makes this switch a lot easier, I find it inconvenient having to use different Shell environments on different operating systems.
On Windows, the Cygwin tools provide a lot of the same tools that are available under UNIX® as well as a BASH shell. Alternatively, you might want to consider using eshell, a shell written in Emacs Lisp that comes as a standard feature in Emacs. If you use the given Emacs configuration, you can access eshell by pressing “F12”.
Using ACL tools with Emacs
I would like to use Emacs with Franz’s ACL but find that I use the Franz tools so much that I can’t afford to not load their IDE.
It doesn’t have to be an either/or decision. On Windows, Franz allows you to specify (under Options) that Emacs is to be the default editor in place of their built-in editor. On UNIX®, Emacs also works very well together with the Franz tools.*
I want to use Emacs on a Windows machine. Unfortunately, I have the Windows cut/copy/paste key bindings burned into my fingertips and would find it very difficult to switch back and forth between the Windows standard for these shortcut keys and the Emacs standard.
Luckily, you don’t have to! Download cua.el and you can continue to use the Windows defaults. In fact, you may find that the following commands in your .emacs file will make Emacs more Windows-like:
;; Windows-like mouse/arrow movement & selection (pc-selection-mode) (delete-selection-mode t) ;; C-z=Undo, C-c=Copy, C-x=Cut, C-v=Paste (needs cua.el) (require 'cua) (CUA-mode t)
Simplified Emacs setup
There was a lot of Emacs Lisp code presented in this paper. Do I really have to type in all this stuff to get started with Emacs and Lisp?
No, you can add yourself just what’s needed to get SLIME working.
You can try Portacle which has everything ready.
There is also a sample .emacs file that can be used to get started. It contains all of the configurations that have been described in this page and (hopefully) should work with some minor tweaking. See the CL-Cookbook page on “Setting up an IDE with Emacs on Windows or Mac OS X”.
Alternatives to Emacs for CL programming
I’ve tried out Emacs and I just can’t get used to it. What other Lisp-friendly alternative are there?
- Vim can be used to edit Lisp code. See some vim plugins.
- There is an Atom package.
- The Franz, LispWorks, Corman, and Digitool commercial Lisp offerings all have Lisp-aware editors.
- Lastly, for true masochists, notepad on Windows or ed on UNIX® can also be used. ;-)
The original material on this page was originally presented at the ILC 2003 conference. A paper with more in-depth coverage of some of the material on this page can be found on Bill Clementson’s ILC2003 page, which is now archived.
It was edited in 2017.
Page source: emacs-ide.md