JUPYTER/COMMON-LISP

Provides Common Lisp kernel support.

Nicknames

common-lisp-jupyter, clj, cl-jupyter

Exports

install, install-image, install-roswell,

install

Function

Install Common Lisp kernel based on the current implementation.

bin-path specifies path to LISP binary.
use-implementation toggles including implementation details in kernel name.
system toggles system versus user installation.
bundle creates a quicklisp bundle for system installations.
local toggles /usr/local/share versus /usr/share for system installations.
prefix key specifies directory prefix for packaging.
root key specifies the root under which the Jupyter folder is found. Is automatically determined if not provided.

(install &key bin-path use-implementation system bundle local prefix root)

install-image

Function

Install Common Lisp kernel based on image of current implementation.

use-implementation toggles including implementation details in kernel name.
prefix key specifies directory prefix for packaging.
root key specifies the root under which the Jupyter folder is found. Is automatically determined if not provided.

(install-image &key use-implementation prefix root)

install-roswell

Function

Install Common Lisp kernel using Roswell. implementation key toggles including implementation details in kernel name.

(install-roswell &key implementation)

kernel

Class

Precedence List

kernel, kernel, source, standard-object, slot-object, t

Slots

jupyter::sink
- :initarg :sink
jupyter::name — Kernel name. Used as a unique identifier in kernel description.
- :initarg :name
jupyter::version — Kernel version.
- :initarg :version
jupyter::banner — Banner text used to describe kernel. Used in kernel_info_reply messages.
- :initarg :banner
jupyter::language-name — Display name of implementation language. Used in kernel_info_reply messages.
- :initarg :language-name
jupyter::language-version — Version of implementation language. Used in kernel_info_reply messages.
- :initarg :language-version
jupyter::mime-type — Default MIME type for source files. Used in kernel_info_reply messages.
- :initarg :mime-type
jupyter::file-extension — Default file extension for source files. Used in kernel_info_reply messages.
- :initarg :file-extension
jupyter::pygments-lexer — Name of Pygments lexer for source files. Used in kernel_info_reply messages.
- :initarg :pygments-lexer
jupyter::codemirror-mode — CodeMirror mode for source files. Used in kernel_info_reply messages.
- :initarg :codemirror-mode
jupyter::help-links — An association list of help links. The car is the description and the cdr is URL. Used in kernel_info_reply messages.
- :initarg :help-links
package — The package in which evaluate-code, code-is-complete and others are called.
- :initarg :package
readtable — The readtable used bu evaluate-code, code-is-complete and others.
- :initarg :readtable
jupyter::connection-file — Pathname of connection file.
- :initarg :connection-file
jupyter::transport [string] — Transport protocol from connection file.
jupyter::ip [string] — IP address from connection file.
jupyter::shell-port [fixnum] — SHELL port from connection file.
jupyter::stdin-port [fixnum] — STDIN port from connection file.
jupyter::iopub-port [fixnum] — IOPUB port from connection file.
jupyter::control-port [fixnum] — CONTROL port from connection file.
jupyter::hb-port [fixnum] — HB port from connection file.
jupyter::signature-scheme [string] — Signature scheme from connection file.
jupyter::key — Signing key from connection file.
jupyter::prompt-prefix — String prefix using in standard-output to indicate the start of prompt.
- :initarg :prompt-prefix
jupyter::prompt-suffix — String suffix using in standard-output to indicate the end of prompt.
- :initarg :prompt-suffix
jupyter::ctx — pzmq ctx handle.
jupyter::mac — Message authentification.
jupyter::hb — Heartbeat channel.
jupyter::shell — SHELL channel.
jupyter::stdin — STDIN channel.
jupyter::control — CONTROL channel.
jupyter::iopub — IOPUB channel.
jupyter::session — Session identifier.
jupyter::input-queue — Input queue used to feed values into execute_result payloads.
- :initarg :input-queue
jupyter::history — Kernel history manager.
jupyter::execution-count — Kernel execution count.
jupyter::comms — Currently open comms.
jupyter::control-thread — Control thread
- :initarg :control-thread
jupyter::shell-thread — Shell thread
jupyter::html-output — HTML display output stream
jupyter::markdown-output — Markdown display output stream
jupyter::error-output — Error output stream
jupyter::standard-output — Standard output stream
jupyter::standard-input — Standard input stream
jupyter::tmp-file-prefix — Prefix for temporary debugger files
jupyter::tmp-file-suffix — Suffix for temporary debugger files
jupyter::hash-seed — Hash seed for temporary debugger files
jupyter::breakpoints — Currently set breakpoints.
jupyter::debugger — Whether the debugger is supported
- :initarg :debugger
jupyter::debugger-started — Whether the debugger has been started
jupyter::threads
environment

Methods

jupyter:inspect-code

  (inspect-code (k kernel) code cursor-pos detail-level)

jupyter:code-is-complete
```
  (code-is-complete (k kernel) code)
```

jupyter:complete-code

  (complete-code (k kernel) match-set code cursor-pos)

jupyter:evaluate-code

  (evaluate-code (k kernel) code &optional source-path breakpoints)

jupyter:debug-activate-breakpoints

  (debug-activate-breakpoints (kernel kernel) source breakpoints)

jupyter:debug-remove-breakpoint

  (debug-remove-breakpoint (kernel kernel) source breakpoint)

jupyter:debug-new-breakpoint

  (debug-new-breakpoint (kernel kernel) source line)

jupyter:debug-initialize
```
  (debug-initialize (k kernel))
```
jupyter:debug-next
```
  (debug-next (k kernel) environment)
```
jupyter:debug-out
```
  (debug-out (k kernel) environment)
```
jupyter:debug-in
```
  (debug-in (k kernel) environment)
```

jupyter:debug-continue

  (debug-continue (k kernel) environment &optional restart-number)

jupyter:debug-abort
```
  (debug-abort (k kernel) environment)
```

jupyter:debug-inspect-variables

  (debug-inspect-variables (kernel kernel) environment)

jupyter:debug-evaluate

  (debug-evaluate (kernel kernel) environment code frame)

jupyter:start
```
  (start (k kernel))
```
kernel-environment — automatically generated reader method
```
  (kernel-environment (kernel kernel))
```
jupyter:stop
```
  (stop (k kernel))
```
jupyter:start
```
  (start (k kernel))
```
jupyter:kernel-debugger-started — Whether the debugger has been started
```
  (setf (kernel-debugger-started (kernel kernel)) new-value)
```
jupyter:kernel-debugger-started — Whether the debugger has been started
```
  (kernel-debugger-started (kernel kernel))
```
jupyter:kernel-prompt-suffix — String suffix using in standard-output to indicate the end of prompt.
```
  (kernel-prompt-suffix (kernel kernel))
```
jupyter:kernel-prompt-prefix — String prefix using in standard-output to indicate the start of prompt.
```
  (kernel-prompt-prefix (kernel kernel))
```