The cl-cont Reference Manual

Table of Contents

The cl-cont Reference Manual

This is the cl-cont Reference Manual, version 0.3.8, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:07:20 2020 GMT+0.

1 Systems

The main system appears first, followed by any subsystem dependency.

1.1 cl-cont

Maintainer

Leslie P. Polzer <polzer@gnu.org>

Author

Slava Akhmechet, Stephen Compall <s11@member.fsf.org>

License

LLGPL

Description

A library that implements continuations by
transforming Common Lisp code to continuation passing style.

Version

0.3.8

Dependencies

• closer-mop
• alexandria

Source

cl-cont.asd (file)

Component

src (module)

2 Modules

Modules are listed depth-first from the system components tree.

2.1 cl-cont/src

Parent

cl-cont (system)

Location

src/

Components

• cont.lisp (file)
• special-transformers.lisp (file)
• helper-transformers.lisp (file)
• walker.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 cl-cont.asd

Location

cl-cont.asd

Systems

cl-cont (system)

Packages

cl-cont-asd

3.1.2 cl-cont/src/cont.lisp

Parent

src (module)

Location

src/cont.lisp

Packages

cl-cont

Exported Definitions

• copy-transformation-context (function)
• cpstransformer (function)
• defcpstransformer (macro)

Internal Definitions

• *special-form-transformers* (special variable)
• call/cc-context (structure)
• call/cc-context-p (function)
• copy-call/cc-context (function)
• copy-hash-table (function)
• ctx-block-tags (function)
• (setf ctx-block-tags) (function)
• ctx-go-tags (function)
• (setf ctx-go-tags) (function)
• ctx-local-functions (function)
• (setf ctx-local-functions) (function)
• expand-form (macro)
• make-call/cc-context (function)

3.1.3 cl-cont/src/special-transformers.lisp

Dependency

cont.lisp (file)

Parent

src (module)

Location

src/special-transformers.lisp

Exported Definitions

• call/cc (function)
• expr-sequence->cps (function)
• lambda/cc (macro)
• let/cc (macro)

Internal Definitions

• accum-mc-sequence->cps (function)
• apply/cc (macro)
• declare-function-names-local (function)
• duplicates-p (function)
• extract-declarations (function)
• f/cc-function (method)
• (setf f/cc-function) (method)
• fdesignator-to-function/cc (function)
• funcall/cc (macro)
• funcallable/cc (class)
• group-tagbody-forms (function)
• lambda-expr->cps (function)
• let*-varlist->cps (function)
• let-varlist->cons-pairs (function)
• make-funcallable (function)
• named-tb-forms>cps (function)
• remove-declarations (function)
• setq->cps (function)
• transform-forms-in-env (macro)
• transform-local-function (function)
• undeclare-function-names-local (function)
• with-local-function-names (macro)

3.1.4 cl-cont/src/helper-transformers.lisp

Dependencies

• cont.lisp (file)
• special-transformers.lisp (file)

Parent

src (module)

Location

src/helper-transformers.lisp

Exported Definitions

• defun/cc (macro)
• without-call/cc (macro)

3.1.5 cl-cont/src/walker.lisp

Dependencies

• cont.lisp (file)
• special-transformers.lisp (file)

Parent

src (module)

Location

src/walker.lisp

Exported Definitions

• expr->cps (function)
• with-call/cc (macro)

Internal Definitions

• application->cps (function)
• apply->cps (function)
• atom->cps (function)
• cons->cps (function)
• funcall->cps (function)

4 Packages

Packages are listed by definition order.

4.1 cl-cont-asd

Source

cl-cont.asd

Use List

• asdf/interface
• common-lisp

4.2 cl-cont

A library that implements continuations by transforming Common Lisp code to continuation passing style.

Source

cont.lisp (file)

Nickname

cont

Use List

common-lisp

Exported Definitions

• call/cc (function)
• copy-transformation-context (function)
• cpstransformer (function)
• defcpstransformer (macro)
• defun/cc (macro)
• expr->cps (function)
• expr-sequence->cps (function)
• lambda/cc (macro)
• let/cc (macro)
• with-call/cc (macro)
• without-call/cc (macro)

Internal Definitions

• *special-form-transformers* (special variable)
• accum-mc-sequence->cps (function)
• application->cps (function)
• apply->cps (function)
• apply/cc (macro)
• atom->cps (function)
• call/cc-context (structure)
• call/cc-context-p (function)
• cons->cps (function)
• copy-call/cc-context (function)
• copy-hash-table (function)
• ctx-block-tags (function)
• (setf ctx-block-tags) (function)
• ctx-go-tags (function)
• (setf ctx-go-tags) (function)
• ctx-local-functions (function)
• (setf ctx-local-functions) (function)
• declare-function-names-local (function)
• duplicates-p (function)
• expand-form (macro)
• extract-declarations (function)
• f/cc-function (generic function)
• f/cc-function (method)
• (setf f/cc-function) (method)
• (setf f/cc-function) (generic function)
• fdesignator-to-function/cc (function)
• funcall->cps (function)
• funcall/cc (macro)
• funcallable/cc (class)
• group-tagbody-forms (function)
• lambda-expr->cps (function)
• let*-varlist->cps (function)
• let-varlist->cons-pairs (function)
• make-call/cc-context (function)
• make-funcallable (function)
• named-tb-forms>cps (function)
• remove-declarations (function)
• setq->cps (function)
• transform-forms-in-env (macro)
• transform-local-function (function)
• undeclare-function-names-local (function)
• with-local-function-names (macro)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Macros

Macro: defcpstransformer NAME LAMBDA-LIST &body BODY

A macro that allows defining special case CPS transformers.

Package

cl-cont

Source

cont.lisp (file)

Macro: defun/cc NAME ARGLIST &body BODY

A helper macro to define a function that supports CALL/CC.

Package

cl-cont

Source

helper-transformers.lisp (file)

Macro: lambda/cc ARGS-LIST &body BODY

A helper macro that wraps LAMBDA definitions with WITH-CALL/CC.

Package

cl-cont

Source

special-transformers.lisp (file)

Macro: let/cc K &body BODY

A shortcut for CALL/CC.

Package

cl-cont

Source

special-transformers.lisp (file)

Macro: with-call/cc &body BODY

Gives access to CALL/CC by transforming BODY to continuation passing style.

Package

cl-cont

Source

walker.lisp (file)

Macro: without-call/cc &body BODY

A macro that allows writing macros to produce non-CPS code uniformly within and without with-call/cc.

Package

cl-cont

Source

helper-transformers.lisp (file)

5.1.2 Functions

Function: call/cc CC

Implements delimited continuations.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: copy-transformation-context CTX

Copies transformation context. This is used for cases when the context has to be ’frozen’ in time and used at a later transformation stage.

Package

cl-cont

Source

cont.lisp (file)

Function: cpstransformer NAME

Returns a CPS transformer named by a given NAME.

Package

cl-cont

Source

cont.lisp (file)

Function: expr->cps EXPR K-EXPR ENV

Transforms expression to CPS style.

Package

cl-cont

Source

walker.lisp (file)

Function: expr-sequence->cps EXPR-LIST K-EXPR ENV

Converts a list of expressions to be evaluated in order to CPS style.

Package

cl-cont

Source

special-transformers.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *special-form-transformers*

A hashtable that maps symbols to functions. Each function acts as a transformer of a special form and must accept three arguments: an s-expression to transform to CPS-style, an an s-expression to continue to, and an environment object.

Package

cl-cont

Source

cont.lisp (file)

5.2.2 Macros

Macro: apply/cc FDESIGNATOR K &rest ARGS

Implements FUNCALL for a CPS converter.

Package

cl-cont

Source

special-transformers.lisp (file)

Macro: expand-form FORM

A helper macro that expands forms by considering local macros.

Package

cl-cont

Source

cont.lisp (file)

Macro: funcall/cc FDESIGNATOR K &rest ARGS

Implements FUNCALL for a CPS converter.

Package

cl-cont

Source

special-transformers.lisp (file)

Macro: transform-forms-in-env FORMS K-EXPR TRANSF-ENV

Macroexpands code within a form that sets up a lexical environment and runs a CPS code walker on it.

Package

cl-cont

Source

special-transformers.lisp (file)

Macro: with-local-function-names NAMES &body BODY

Runs BODY within a transformation environment in which functions named by NAMES are declared as local.

Package

cl-cont

Source

special-transformers.lisp (file)

5.2.3 Functions

Function: accum-mc-sequence->cps EXPR-LIST FN K-EXPR ARGS ENV

Converts a list of expressions to be evaluated in order to CPS style and collects their results (including multiple values).

Package

cl-cont

Source

special-transformers.lisp (file)

Function: application->cps APP-SYM CONS K-EXPR ARGS ENV

Transforms a function application to CPS style.

Package

cl-cont

Source

walker.lisp (file)

Function: apply->cps CONS K-EXPR ARGS ENV

Transforms APPLY to CPS style.

Package

cl-cont

Source

walker.lisp (file)

Function: atom->cps ATOM K-EXPR

Transforms an atom to CPS style.

Package

cl-cont

Source

walker.lisp (file)

Function: call/cc-context-p OBJECT

Package

cl-cont

Source

cont.lisp (file)

Function: cons->cps CONS K-EXPR ENV

Transforms a cons to CPS style.

Package

cl-cont

Source

walker.lisp (file)

Function: copy-call/cc-context INSTANCE

Package

cl-cont

Source

cont.lisp (file)

Function: copy-hash-table HT

Shallow hashtable copy.

Package

cl-cont

Source

cont.lisp (file)

Function: ctx-block-tags INSTANCE

Function: (setf ctx-block-tags) VALUE INSTANCE

Package

cl-cont

Source

cont.lisp (file)

Function: ctx-go-tags INSTANCE

Function: (setf ctx-go-tags) VALUE INSTANCE

Package

cl-cont

Source

cont.lisp (file)

Function: ctx-local-functions INSTANCE

Function: (setf ctx-local-functions) VALUE INSTANCE

Package

cl-cont

Source

cont.lisp (file)

Function: declare-function-names-local NAMES

Declares function names local in a transformation environment.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: duplicates-p SEQUENCE &key KEY TEST

Returns true if there are duplicate elements in the sequence, false otherwise.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: extract-declarations EXPR-LIST

Returns a list of declarations extracted from the EXPR-LIST.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: fdesignator-to-function/cc FDESIGNATOR

Converts a function designator to a function/cc.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: funcall->cps CONS K-EXPR ARGS ENV

Transforms FUNCALL to CPS style.

Package

cl-cont

Source

walker.lisp (file)

Function: group-tagbody-forms EXPR-LIST

Groups TAGBODY forms into a list where each item is a list with CAR being the go-tag name (or nil for default first tag), and CDR is a list of expressions for the tag.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: lambda-expr->cps CONS K-EXPR ENV

Converts a LAMBDA expression to CPS style.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: let*-varlist->cps VARLIST LET-BODY K-EXPR ENV

Converts a list of variables from a LET* expression to CPS style.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: let-varlist->cons-pairs VARLIST

Converts a list of LET vars into name/value cons pairs.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: make-call/cc-context &key (BLOCK-TAGS BLOCK-TAGS) (GO-TAGS GO-TAGS) (LOCAL-FUNCTIONS LOCAL-FUNCTIONS)

Package

cl-cont

Source

cont.lisp (file)

Function: make-funcallable FUNCTION

Creates an instance of FUNCALLABLE/CC.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: named-tb-forms>cps FORMS K-EXPR ENV

Takes a list of named TAGBODY forms and converts CAR form to CPS.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: remove-declarations EXPR-LIST

Removes declarations from the EXPR-LIST.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: setq->cps SETQ-PAIRS K-EXPR ENV

Converts a list of SETQ pairs to CPS style.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: transform-local-function FN ENV IN-ENV-P

Transforms a local (FLET or LABELS) function to CPS style.

Package

cl-cont

Source

special-transformers.lisp (file)

Function: undeclare-function-names-local NAMES

Undeclares function names local in a transformation environment.

Package

cl-cont

Source

special-transformers.lisp (file)

5.2.4 Generic functions

Generic Function: f/cc-function OBJECT

Generic Function: (setf f/cc-function) NEW-VALUE OBJECT

Package

cl-cont

Methods

Method: f/cc-function (FUNCALLABLE/CC funcallable/cc)

Method: (setf f/cc-function) NEW-VALUE (FUNCALLABLE/CC funcallable/cc)

A function object that accepts a continuation argument.

Source

special-transformers.lisp (file)

5.2.5 Structures

Structure: call/cc-context ()

A structure that represents a context used during call/cc transformation.

Package

cl-cont

Source

cont.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: block-tags

Initform

(make-hash-table)

Readers

ctx-block-tags (function)

Writers

(setf ctx-block-tags) (function)

Slot: go-tags

Initform

(make-hash-table)

Readers

ctx-go-tags (function)

Writers

(setf ctx-go-tags) (function)

Slot: local-functions

Readers

ctx-local-functions (function)

Writers

(setf ctx-local-functions) (function)

5.2.6 Classes

Class: funcallable/cc ()

A structure that represents a funcallable object

Package

cl-cont

Source

special-transformers.lisp (file)

Direct superclasses

funcallable-standard-object (class)

Direct methods

• describe-object (method)
• documentation (method)
• documentation (method)
• f/cc-function (method)
• f/cc-function (method)

Direct slots

Slot: function

A function object that accepts a continuation argument.

Initargs

:function

Readers

f/cc-function (generic function)

Writers

(setf f/cc-function) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types