The slynk-macrostep Reference Manual

This is the slynk-macrostep Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:54:38 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 slynk-macrostep

MACROSTEP support for Slynk

Author

João Távora

Dependency

slynk (system).

Source

slynk-macrostep.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 slynk-macrostep/slynk-macrostep.asd

Source

slynk-macrostep.asd.

Parent Component

slynk-macrostep (system).

ASDF Systems

slynk-macrostep.


3.1.2 slynk-macrostep/package.lisp

Source

slynk-macrostep.asd.

Parent Component

slynk-macrostep (system).

Packages

slynk-macrostep.


3.1.3 slynk-macrostep/collect-macro-forms.lisp

Source

slynk-macrostep.asd.

Parent Component

slynk-macrostep (system).

Internals

3.1.4 slynk-macrostep/slynk-macrostep.lisp

Source

slynk-macrostep.asd.

Parent Component

slynk-macrostep (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 slynk-macrostep

Source

package.lisp.

Use List
  • common-lisp.
  • slynk-api.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Ordinary functions

Function: macro-form-p (string compiler-macros? context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: macrostep-expand-1 (string compiler-macros? context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *macrostep-placeholder*
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Special Variable: *macrostep-tag*
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Special Variable: +whitespace+
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.


5.2.2 Macros

Macro: throw-collected-macro-forms (form)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Macro: throw-expansion (form)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Macro: with-collected-macro-forms ((forms &optional result) instrumented-form &body body)

Collect macro forms by locally binding *MACROEXPAND-HOOK*. Evaluates INSTRUMENTED-FORM and collects any forms which undergo macro-expansion into a list. Then evaluates BODY with FORMS bound to the list of forms, and RESULT (optionally) bound to the value of INSTRUMENTED-FORM.

Package

slynk-macrostep.

Source

collect-macro-forms.lisp.


5.2.3 Ordinary functions

Function: call-with-collected-macro-forms (body-fn instrumented-fn)
Package

slynk-macrostep.

Source

collect-macro-forms.lisp.

Function: collect-form-positions (expansion printed-expansion forms)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: collect-macro-forms (form &optional env)

Collect subforms of FORM which undergo (compiler-)macro expansion. Returns two values: a list of macro forms and a list of compiler macro forms.

Package

slynk-macrostep.

Source

collect-macro-forms.lisp.

Function: collect-macro-forms-in-context (form context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: collect-marker-positions (string position-count)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: enclose-form-in-context (form context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: expand-form-once (form compiler-macros? context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: find-non-whitespace-position (string position)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: macro-form-type (form compiler-macros? context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: macroexpand-1-in-context (form context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: macroexpand-and-catch (form context)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: make-marker-char (id)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: make-tracking-pprint-dispatch (forms)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: marker-char-id (char)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: marker-char-p (char)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: pprint-to-string (object &optional pprint-dispatch)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Function: whitespacep (char)
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.


5.2.4 Conditions

Condition: expansion-in-context-failed
Package

slynk-macrostep.

Source

slynk-macrostep.lisp.

Direct superclasses

simple-error.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   E   F   M   P   T   W  
Index Entry  Section

C
call-with-collected-macro-forms: Private ordinary functions
collect-form-positions: Private ordinary functions
collect-macro-forms: Private ordinary functions
collect-macro-forms-in-context: Private ordinary functions
collect-marker-positions: Private ordinary functions

E
enclose-form-in-context: Private ordinary functions
expand-form-once: Private ordinary functions

F
find-non-whitespace-position: Private ordinary functions
Function, call-with-collected-macro-forms: Private ordinary functions
Function, collect-form-positions: Private ordinary functions
Function, collect-macro-forms: Private ordinary functions
Function, collect-macro-forms-in-context: Private ordinary functions
Function, collect-marker-positions: Private ordinary functions
Function, enclose-form-in-context: Private ordinary functions
Function, expand-form-once: Private ordinary functions
Function, find-non-whitespace-position: Private ordinary functions
Function, macro-form-p: Public ordinary functions
Function, macro-form-type: Private ordinary functions
Function, macroexpand-1-in-context: Private ordinary functions
Function, macroexpand-and-catch: Private ordinary functions
Function, macrostep-expand-1: Public ordinary functions
Function, make-marker-char: Private ordinary functions
Function, make-tracking-pprint-dispatch: Private ordinary functions
Function, marker-char-id: Private ordinary functions
Function, marker-char-p: Private ordinary functions
Function, pprint-to-string: Private ordinary functions
Function, whitespacep: Private ordinary functions

M
Macro, throw-collected-macro-forms: Private macros
Macro, throw-expansion: Private macros
Macro, with-collected-macro-forms: Private macros
macro-form-p: Public ordinary functions
macro-form-type: Private ordinary functions
macroexpand-1-in-context: Private ordinary functions
macroexpand-and-catch: Private ordinary functions
macrostep-expand-1: Public ordinary functions
make-marker-char: Private ordinary functions
make-tracking-pprint-dispatch: Private ordinary functions
marker-char-id: Private ordinary functions
marker-char-p: Private ordinary functions

P
pprint-to-string: Private ordinary functions

T
throw-collected-macro-forms: Private macros
throw-expansion: Private macros

W
whitespacep: Private ordinary functions
with-collected-macro-forms: Private macros