\end{describe}
\begin{describe}{mac}
- {define-c-type-syntax @<name> @<lambda-list> @<form>^* @> @<name>}
+ {define-c-type-syntax @<name> @<lambda-list> \\ \ind
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^* \-
+ \nlret @<name>}
Defines the symbol @<name> as a new type operator. When a list of the form
@|(@<name> @<argument>^*)| is used as a type specifier, the @<argument>s
are bound to fresh variables according to @<lambda-list> (a destructuring
\end{describe}
\begin{describe}{mac}
- {maybe-in-parens (@<stream-var> @<guard-form>) @<form>^*}
+ {maybe-in-parens (@<stream-var> @<guard-form>)
+ @<declaration>^*
+ @<form>^*}
The @<guard-form> is evaluated, and then the @<form>s are evaluated in
sequence within a pretty-printer logical block writing to the stream named
by the symbol @<stream-var>. If the @<guard-form> evaluates to nil, then
\end{describe}
\begin{describe}{mac}
- {definst @<code> (@<streamvar> \&key @<export>) (@<arg>^*)
- @<body-form>^*}
+ {definst @<code> (@<streamvar> \&key @<export>) (@<arg>^*) \\ \ind
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^* \-
+ \nlret @<code>}
\end{describe}
\begin{describe}{mac}
- {format-compound-statement (@<stream> @<child> \&optional @<morep>)
- @<body-form>^*}
+ {format-compound-statement
+ (@<stream> @<child> \&optional @<morep>) \\ \ind
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
\begin{table}
\end{describe}
\begin{describe}{mac}
- {with-temporary-var (@<codegen> @<var> @<type>) @<body-form>^*
- @> @<value>^*}
+ {with-temporary-var (@<codegen> @<var> @<type>) \\ \ind
+ @<declaration>^* \\
+ @<form>^* \-
+ \nlret @<value>^*}
\end{describe}
\begin{describe}{fun}{deliver-expr @<codegen> @<target> @<expr>}
\end{quote}
\end{describe}
-\begin{describe}{mac}{example-macro
- ( @{ @<symbol> @! (@<symbol> @<form>) @}^* ) \\ \ind
- @[[ @<declaration>^* @! @<documentation-string> @]] \\
- @<body-form>^*
- \nlret @<value>^*}
+\begin{describe}{mac}
+ {example-macro
+ (@{ @<symbol> @! (@<symbol> @<form>) @}^*) \\ \ind
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*
+ \nlret @<value>^*}
The synopsis for a macro describes the acceptable syntax using the
following notation.
\begin{itemize}
\begin{describe}{mac}
{with-gensyms (@{ @<var> @! (@<var> @[@<name>@]) @}^*) \\ \ind
- @<body-form>^*}
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
\begin{describe}{mac}
{once-only (@[[ :environment @<env> @]]
@{ @<var> @! (@<var> @[@<value-form>@]) @}^*) \\ \ind
- @<body-form>^*}
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
\begin{describe}{mac}
- {parse-body @<body> @> @<doc-string> @<declarations> @<body-forms>}
+ {parse-body @<body> \&key :docp :declp
+ @> @<doc-string> @<declarations> @<body-forms>}
\end{describe}
\begin{describe}{cls}{loc}
\begin{describe}{fun}{locp @<object> @> @<generalized-boolean>}
\end{describe}
-\begin{describe}{mac
ro}{locf @<place> @> @<locative>}
+\begin{describe}{mac}{locf @<place> @> @<locative>}
\end{describe}
\begin{describe*}
{with-locatives
@{ @<var> @! (@{ @<var> @!
(@<var> @[@<locative>@]) @}^*) @} \\ \ind
- @<body-form>^*}
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
\begin{describe}{sym}{it}
\begin{describe}{mac}{aif @<condition> @<consequent> @[@<alt>@]}
\end{describe}
-\begin{describe}{mac}{awhen @<condition> @<body-form>^*}
+\begin{describe}{mac}{awhen @<condition> @<form>^*}
\end{describe}
\begin{describe}{mac}{acond @{ (@<condition> @<form>^*) @}^*}
{categorize (\=@<item-var> @<items>
@[[ :bind (@{ @<var> @! (@<var> @[@<value>@]) @}^*) @]])
\\ \ind\ind
- (@{ @<cat-var> @<cat-predicate> @}^*) \- \\
+ (@{ (@<cat-var> @<cat-predicate>) @}^*) \- \\
+ @<declaration>^* \\
@<body-form>^* \-
\nlret @<value>^*}
\end{describe}
{maybe-print-unreadable-object (@<object> @<stream>
@[[ :type @<type> @!
:identity @<identity> @]]) \\ \ind
- @<body-form>^*}
+ @<declaration>^* \\
+ @<form>^*}
\end{describe}
\begin{describe}{mac}
{dosequence (@<var> @<sequence>
@[[ :start @<start> @! :end @<end> @!
:indexvar @<var> @]]) \\ \ind
- @{ @<tag> @! @<body-form> @}^*}
+ @<declaration>^* \\
+ @{ @<tag> @! @<statement> @}^*}
\end{describe}
\begin{describe}{mac}
\begin{describe}{mac}
{default-slot (@<instance> @<slot> @[@<slot-names>@]) \\ \ind
- @<body-form>^*}
+ @<form>^*}
\end{describe}
\begin{describe}{mac}
{define-on-demand-slot @<class> @<slot> (@<instance>) \\ \ind
- @<body-form>^*}
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*}
\end{describe}
%%%--------------------------------------------------------------------------
\begin{describe}{fun}{option-parse-next @<option-parser>}
\end{describe}
-\begin{describe}{mac}{option-parse-try @<body-form>^*}
+\begin{describe}{mac}{option-parse-try @<form>^*}
\end{describe}
-\begin{describe}{mac}{with-unix-error-reporting () @<body-form>^*}
+\begin{describe}{mac}{with-unix-error-reporting () @<form>^*}
\end{describe}
\begin{describe}{mac}
{defopthandler @<name> (@<var> @[@<arg>@]) @<lambda-list> \\ \ind
- @<body-form>^*}
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*}
\end{describe}
\begin{describe}{fun}
\begin{describe}{opt}{list \&optional @<handler> \&rest @<handler-args>}
\end{describe}
-\begin{describe}{mac}{defoptmacro @<name> @<lambda-list> @<body-form>^*}
+\begin{describe}{mac}
+ {defoptmacro @<name> @<lambda-list> \\ \ind
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^*}
\end{describe}
\begin{describe}{fun}{parse-option-form @<form>}
(:opt-arg @<arg-name>) @! \\
@<keyword> @! (:tag @<tag>) @!
(:negated-tag @<tag>) @! \\
- @{ (@<handler> @<var> @<handler-arg>^*) @}^* @]]) @}^*}
+ @{ (@<handler> @<var> @<handler-arg>^*) @}^*
+ @]]) @}^*}
\end{describe}
\begin{describe}{fun}
\begin{describe}{fun}{pset-map @<func> @<pset>}
\end{describe}
-\begin{describe}{mac}{with-pset-iterator (@<iter> @<pset>) @<body-form>^*}
+\begin{describe}{mac}
+ {with-pset-iterator (@<iter> @<pset>) @<declaration>^* @<form>^*}
\end{describe}
\begin{describe}{fun}
{default-slot-from-property
(@<instance> @<slot> @[@<slot-names>@]) \\ \ind\ind
(@<pset> @<property> @<type> @[@<prop-var> @<convert-form>^*@]) \- \\
+ @<declaration>^* \\
@<default-form>^*}
\end{describe}
\end{describe*}
\begin{describe}{mac}
- {with-default-error-location (@<floc>) @<body-form>^* @> @<value>^*}
+ {with-default-error-location (@<floc>) @<declaration>^* @<form>^*
+ @> @<value>^*}
\end{describe}
\begin{describe}{mac}
- {count-and-report-errors () @<body-form>^*
+ {count-and-report-errors () @<declaration>^* @<form>^*
@> @<value> @<n-errors> @<n-warnings>}
\end{describe}
\end{describe}
\begin{describe}{mac}
- {with-scanner-place (@<place> @<scanner>) @<body-form>^* @> @<value>^*}
+ {with-scanner-place (@<place> @<scanner>) @<declarations>^* @<form>^*
+ @> @<value>^*}
Capture the @<scanner>'s current position as a place, evaluate the
@<body-form>s as an implicit progn with the variable @<place> bound to the captured
place. When control leaves the @<body-form>s, the place is released. The return
\begin{describe}{mac}
{defparse @<name> (@[[ :context (@<var> @<context-class>) @]]
@<destructuring-lambda-list-item>^*) \\ \ind
- @<body-form>^* \-
+ @[[ @<declaration>^* @! @<doc-string> @]] \\
+ @<form>^* \-
\nlret @<name>}
\end{describe}
\begin{describe}{mac}
{with-parser-context
(@<context-class> @{ @<init-keyword> @<value> @}^*) \\ \ind
- @<body-form>^* \-
+ @<declaration>^* \\
+ @<form>^* \-
\nlret @<value>^*}
\end{describe}
\begin{describe}{mac}
{when-parse (@[@<result-var>@]) @<parser> \\ \ind
- @<body-form>^* \-
+ @<form>^* \-
\nlret @<value>^*}
\end{describe}
\end{describe}
\begin{describe}{mac}
- {define-pluggable-parser @<symbol> @<tag> @<lambda-list> @<body-form>^*}
+ {define-pluggable-parser @<symbol> @<tag> @<lambda-list>
+ @[[ @<declaration>^* @! @<doc-string> @]]
+ @<form>^*}
\end{describe}
\begin{describe}{gf}{parser-capture-place @<context> @> @<form>}
\end{describe}
\begin{describe}{mac}
- {with-parser-place (@<place-var> @<context>) @<body-form>^*}
+ {with-parser-place (@<place-var> @<context>)
+ @[[ @<declaration>^* @! @<doc-string> @]]
+ @<form>^*}
\end{describe}
\begin{describe}{parseform}{peek @<parser>}
\begin{describe*}
{\dhead{mac}{preop @<name> (@<operand-var> @<lprec>)
- @<body-form>^*
+ @<declaration>^* @<form>^*
@> @<prefix-operator>}
\dhead{mac}{postop @<name>
(@<operand-var> @<lprec> @[[ :rprec @<rprec> @]])
- @<body-form>^*
-
@> @<postfix-operator>}
+ @<declaration>^* @<form>^*
+
\nlret @<postfix-operator>}
\dhead{mac}{binop @<name> (@<operand-var> @<lprec> @<rprec> @<assoc>)
- @<body-form>^*
+ @<declaration>^*@<form>^*
@> @<binary-operator>}}
\end{describe*}
~mdw / sod / commitdiff