From 8399be6f4eb6e6f1d4ce114b32b7bd905e4686a9 Mon Sep 17 00:00:00 2001 Message-Id: <8399be6f4eb6e6f1d4ce114b32b7bd905e4686a9.1715455334.git.mdw@distorted.org.uk> From: Mark Wooding Date: Wed, 2 Aug 2017 10:32:40 +0100 Subject: [PATCH] doc/syntax.tex: Describe the built-in properties for objects. Organization: Straylight/Edgeware From: Mark Wooding All a bit rough, but at least there's a place to write this stuff down now. --- doc/syntax.tex | 81 +++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 77 insertions(+), 4 deletions(-) diff --git a/doc/syntax.tex b/doc/syntax.tex index 50cea66..acf6f3f 100644 --- a/doc/syntax.tex +++ b/doc/syntax.tex @@ -210,6 +210,16 @@ brackets, braces or parenthesis ends the fragment. A @ is the top-level syntactic item. A module consists of a sequence of definitions. +[FIXME] +Properties: +\begin{description} +\item[@"module_class"] A symbol naming the Lisp class to use to + represent the module. +\item[@"guard"] An identifier to use as the guard symbol used to prevent + multiple inclusion in the header file. +\end{description} + + \subsection{Simple definitions} \label{sec:syntax.module.simple} \subsubsection{Importing modules} @@ -620,6 +630,15 @@ It is not possible to declare a slot with function type: such an item is interpreted as being a @ or @. Pointers to functions are fine. +Properties: +\begin{description} +\item[@"slot_class"] A symbol naming the Lisp class to use to represent the + direct slot. +\item[@"initarg"] An identifier naming an initialization argument which can + be used to provide a value for the slot. See + \xref{sec:concepts.lifecycle.birth} for the details. +\end{description} + An @, if present, is treated as if a separate @ containing the slot name and initializer were present. For example, @@ -655,10 +674,16 @@ The first component of the @ must be the nickname of one of the class's superclasses (including itself); the second must be the name of a slot defined in that superclass. -An @|initarg| property may be set on an instance slot initializer (or a -direct slot definition). See \xref{sec:concepts.lifecycle.birth} for the -details. An initializer item must have either an @|initarg| property, or an -initializer expression, or both. +Properties: +\begin{description} +\item[@"initializer_class"] A symbol naming the Lisp class to use to + represent the initializer. +\item[@"initarg"] An identifier naming an initialization argument which can + be used to provide a value for the slot. See + \xref{sec:concepts.lifecycle.birth} for the details. An initializer item + must have either an @|initarg| property, or an initializer expression, or + both. +\end{description} Each class may define at most one initializer item with an explicit initializer expression for a given slot. @@ -670,6 +695,7 @@ initializer expression for a given slot. @^+ $[\mbox{@}]$ ";" \end{grammar} +Properties: none. \subsubsection{Fragment items} \begin{grammar} @@ -685,6 +711,45 @@ initializer expression for a given slot. $[\mbox{@}]$ @[@] \end{grammar} +Properties: +\begin{description} +\item[@"message_class"] A symbol naming the Lisp class to use to represent + the message. +\item[@"combination"] A keyword naming the aggregating method combination to + use. +\item[@"most_specific"] A keyword, either @`first' or @`last', according to + whether the most specific applicable method should be invoked first or + last. +\end{description} + +Properties for the @|custom| aggregating method combination: +\begin{description} +\item[@"retvar"] An identifier for the return value from the effective + method. The default is @|sod__ret|. Only permitted if the message return + type is not @|void|. +\item[@"valvar"] An identifier holding each return value from a direct method + in the effective method. The default is @|sod__val|. Only permitted if + the method return type (see @"methty" below) is not @|void|. +\item[@"methty"] A C type, which is the return type for direct methods of + this message. +\item[@"decls"] A code fragment containing declarations to be inserted at the + head of the effective method body. The default is to insert nothing. +\item[@"before"] A code fragment containing initialization to be performed at + the beginning of the effective method body. The default is to insert + nothing. +\item[@"first"] A code fragment to set the return value after calling the + first applicable direct method. The default is to use the @"each" + fragment. +\item[@"each"] A code fragment to set the return value after calling a direct + method. If @"first" is also set, then it is used after the first direct + method instead of this. The default is to insert nothing, which is + probably not what you want. +\item[@"after"] A code fragment inserted at the end of the effective method + body. The default is to insert nothing. +\item[@"count"] An identifier naming a variable to be declared in the + effective method body, of type @|size_t|, holding the number of applicable + methods. The default is not to provide such a variable. +\end{description} \subsubsection{Method items} \begin{grammar} @@ -695,6 +760,14 @@ initializer expression for a given slot. ::= "{" "}" | "extern" ";" \end{grammar} +Properties: +\begin{description} +\item[@"method_class"] A symbol naming the Lisp class to use to represent + the direct method. +\item[@"role"] A keyword naming the direct method's rôle. For the built-in + `simple' message classes, the acceptable rôle names are @|before|, + @|after|, and @|around|. By default, a primary method is constructed. +\end{description} %%%----- That's all, folks -------------------------------------------------- -- [mdw]