User Guide

This guide is for version 0.3.0 and up unless mentioned otherwise!

Installation

Windows

Manual Installation

• Download SBCL from http://prdownloads.sourceforge.net/sbcl/sbcl-2.3.0-x86-64-windows-binary.msi and install it.
• Download quicklisp from https://beta.quicklisp.org/quicklisp.lisp and save it to some folder, in my example D:\lisp
• Start command line and navigate to folder with quicklisp.lisp (ie in my example D:\lisp (D: and cd lisp))
• Type sbcl - it should be on path if you installed it via msi binary
• Type (load "quicklisp.lisp") and press enter

• It should end with T. Then type (quicklisp-quickstart:install) end press enter. After download it should look like this:

• Quicklisp is now installed in your home directory (C:\Users\<name>\quicklisp)

• In the IDE open Settings > Languages & Frameworks > Common Lisp SDKs, then click on Add New SBCL SDK

• Then locate sbcl.exe for SBCL executable.

• Same with SBCL.core file. Then find your setup.lisp inside quicklisp folder in your home and add it to the sdk. Should look like this when filled:

• Clicking on Verify SBCL SDK will download all necessary libraries requires and will verify the SDK. Wait until verification is finished, it can take some time to download all dependencies. Click Save and then Apply to add your SDK.

• Then go to Project: <yourprojectname> > Common Lisp SDK and click the refresh icon and select your installed SDK from the menu and hit Apply

• Done!

Mac

Since I don't own Mac you are on your own. But brew can probably be used or you can google how to get sbcl on mac. Rest should be the same for linux version.

Linux

Repository Installation

Installing SBCL from repo works and usually all you need to enter into path is sbcl. Install quicklisp via

$ curl -o /tmp/ql.lisp http://beta.quicklisp.org/quicklisp.lisp $ sbcl --no-sysinit --no-userinit --load /tmp/ql.lisp --eval '(quicklisp-quickstart:install :path "~/.quicklisp") --quit

Usage

To unlock most potential out of plugin you have to start sbcl instance. This is done on Common Lisp toolbar, green icon "Start SBCL Instance".

You can stop the instance by following red button. If you get this error you need to setup SDK, see above.

How to..

...open REPL?

Click on the "Create Lisp REPL" + button in Common Lisp toolbar.

To evaluate expression add one blank line at the end. You can use arrows to get to previous expressions and such.

...create lisp file?

Right click on folder and then "New > Asdf system/Common Lisp Lisp File/Common Lisp CL File" to create basic template

...evaluate lisp file?

Right click on a file in project explorer and pick Evaluate File option:

Alternatively, you can right click in any opened file and then select "Evaluate Current File"

...evaluate expressions?

There are options when you right click:

• Evaluate Selected Region will evaluate selected region as an expression. You can evaluate parts of toplevel expressions and inside comments.

• • Default key combination: Ctrl+Alt+R

• Evaluate This S-Expression will evaluate S-Expression cursor is in. Only right this expression will be evaluated, not whole toplevel. Will also select the evaluated expression.

• • Default key combination: Ctrl+Alt+F

• Evaluate Previous S-Expression will evaluate S-Expression left of cursor. Will also select the evaluated expression.

• • Default key combination: Ctrl+Alt+E

• Evaluate Next S-Expression will evaluate S-Expression cursor is in. Will also select the evaluated expression.

• • Default key combination: Ctrl+Alt+Q