Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the form-fiddle Reference Manual, version 1.1.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:47:52 2018 GMT+0.
| • Introduction: | What form-fiddle is all about | |
| • Systems: | The systems documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
Often times I need to destructure a form definition in a macro. This is a set of simple utilities to help with that.
There's individual functions to extract each part of a lambda-definition-form: function, name, qualifiers, lambda-list, body, declarations, docstring and the forms. You can get all in one with split-lambda-form, or directly as a binding macro with with-destructured-lambda-form.
(split-lambda-form '(defun lambda-body (lambda-form)
(cddr lambda-form)))
(with-destructured-lambda-form (:forms forms)
'(defmacro foo (bar)
(declare (ignore bar))
"Testing macro!"
(print "test!"))
forms)
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The form-fiddle system: |
Nicolas Hafner <shinmera@tymoon.eu>
Nicolas Hafner <shinmera@tymoon.eu>
Artistic
A collection of utilities to destructure lambda forms.
1.1.0
documentation-utils
form-fiddle.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The form-fiddle.asd file: | ||
| • The form-fiddle/package.lisp file: | ||
| • The form-fiddle/form-fiddle.lisp file: | ||
| • The form-fiddle/documentation.lisp file: |
Next: The form-fiddle/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
form-fiddle.asd
form-fiddle (system)
Next: The form-fiddle/form-fiddle<dot>lisp file, Previous: The form-fiddle<dot>asd file, Up: Lisp files [Contents][Index]
form-fiddle (system)
package.lisp
Next: The form-fiddle/documentation<dot>lisp file, Previous: The form-fiddle/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
form-fiddle (system)
form-fiddle.lisp
Previous: The form-fiddle/form-fiddle<dot>lisp file, Up: Lisp files [Contents][Index]
form-fiddle.lisp (file)
form-fiddle (system)
documentation.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The form-fiddle package: |
package.lisp (file)
org.shirakumo.form-fiddle
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: | ||
| • Internal definitions: |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported macros: | ||
| • Exported functions: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Destructures the body according to split-body-kargs.
OTHER-OPTIONS will be bound to contain all the options that occur in the body but were not explicitly requested in OPTIONS. BODY will be bound to the remaining body forms. Each option in OPTIONS can be either a symbol or a list of symbol and default. The symbol is automatically converted to a keyword to match against the body options.
form-fiddle.lisp (file)
Destructures the given EXPRESSION into its lambda-form parts.
form-fiddle.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
Returns all BODY forms of the lambda-form.
|¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯v¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯| (function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Returns the DECLARATIONS of the lambda-form, if any.
v
(function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Returns the DOCSTRING of the lambda-form, if any.
v
(function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Returns the actual body forms of the lambda-form, if any.
v (function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Returns the defining FUNCTION of the lambda-form.
v
(function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Returns the LAMBDA-LIST of the lambda-form.
v
(function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Returns the NAME of the lambda-form, if any.
v
(function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Returns the QUALIFIERS of the lambda-form.
v
(function [name] qualifier* lambda-list [[docstring? | declaration*]] form*)
form-fiddle.lisp (file)
Parses the body into two separate lists of forms and options.
This is found in some expressions like in the clause body of RESTART-CASE.
BODY ::= OPTION* FORM*
OPTION ::= KEYWORD EXPRESSION
form-fiddle.lisp (file)
Returns all parts of a lambda-form as a list in the following order: FUNCTION NAME QUALIFIERS LAMBDA-LIST DOCSTRING DECLARATIONS FORMS
form-fiddle.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal functions: |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Returns T if the given thing is a declaration expression.
form-fiddle.lisp (file)
Returns T if the given thing is a docstring.
form-fiddle.lisp (file)
form-fiddle.lisp (file)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L |
|---|
| Jump to: | F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | D F L M R S W |
|---|
| Jump to: | D F L M R S W |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | F P S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| F | |||
form-fiddle: | The form-fiddle system | ||
form-fiddle: | The form-fiddle package | ||
| | |||
| P | |||
Package, form-fiddle: | The form-fiddle package | ||
| | |||
| S | |||
System, form-fiddle: | The form-fiddle system | ||
| | |||
| Jump to: | F P S |
|---|