X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/sod/blobdiff_plain/391c5a3467f5ac9a1e2b3aa9bd7f50792a80f159..0e5c0b9edba8966aba72acb2b101b7a13d80f45a:/doc/syntax.tex diff --git a/doc/syntax.tex b/doc/syntax.tex index 3727013..0e14e17 100644 --- a/doc/syntax.tex +++ b/doc/syntax.tex @@ -26,51 +26,7 @@ \chapter{Module syntax} \label{ch:syntax} %%%-------------------------------------------------------------------------- - -Fortunately, Sod is syntactically quite simple. The notation is slightly -unusual in order to make the presentation shorter and easier to read. - -Anywhere a simple nonterminal name $x$ may appear in the grammar, an -\emph{indexed} nonterminal $x[a_1, \ldots, a_n]$ may also appear. On the -left-hand side of a production rule, the indices $a_1$, \ldots, $a_n$ are -variables which vary over all nonterminal and terminal symbols, and the -variables may also appear on the right-hand side in place of a nonterminal. -Such a rule stands for a family of rules, in each variable is replaced by -each possible simple nonterminal or terminal symbol. - -The letter $\epsilon$ denotes the empty nonterminal -\begin{quote} - \syntax{$\epsilon$ ::=} -\end{quote} - -The following indexed productions are used throughout the grammar, some often -enough that they deserve special notation. -\begin{itemize} -\item @[$x$@] abbreviates @$[x]$, denoting an optional occurrence - of $x$: - \begin{quote} - \syntax{@[$x$@] ::= $[x]$ ::= $\epsilon$ @! $x$} - \end{quote} -\item $x^*$ abbreviates @$[x]$, denoting a sequence of zero or - more occurrences of $x$: - \begin{quote} - \syntax{$x^*$ ::= $[x]$ ::= - $\epsilon$ @! $[x]$ $x$} - \end{quote} -\item $x^+$ abbreviates @$[x]$, denoting a sequence of zero or - more occurrences of $x$: - \begin{quote} - \syntax{$x^+$ ::= $[x]$ ::= $[x]$ $x$} - \end{quote} -\item @$[x]$ denotes a sequence of one or more occurrences of $x$ - separated by commas: - \begin{quote} - \syntax{$[x]$ ::= $x$ @! $[x]$ "," $x$} - \end{quote} -\end{itemize} - -\subsection{Lexical syntax} -\label{sec:syntax.lex} +\section{Lexical syntax} \label{sec:syntax.lex} Whitespace and comments are discarded. The remaining characters are collected into tokens according to the following syntax. @@ -87,7 +43,8 @@ This syntax is slightly ambiguous, and is disambiguated by the \emph{maximal munch} rule: at each stage we take the longest sequence of characters which could be a token. -\subsubsection{Identifiers} \label{sec:syntax.lex.id} + +\subsection{Identifiers} \label{sec:syntax.lex.id} \begin{grammar} ::= @^* @@ -115,7 +72,8 @@ also an ambiguity (inherited from C) in the declaration syntax which is settled by distinguishing type names from other identifiers at a lexical level. -\subsubsection{String and character literals} \label{sec:syntax.lex.string} + +\subsection{String and character literals} \label{sec:syntax.lex.string} \begin{grammar} ::= "\"" @^* "\"" @@ -167,13 +125,15 @@ Sod understands only integers, not floating-point numbers; its integer syntax goes slightly beyond C in allowing a @`0o' prefix for octal and @`0b' for binary. However, length and signedness indicators are not permitted. -\subsubsection{Punctuation} \label{sec:syntax.lex.punct} + +\subsection{Punctuation} \label{sec:syntax.lex.punct} \begin{grammar} ::= any nonalphanumeric character other than "_", "\"" or "'" \end{grammar} -\subsubsection{Comments} \label{sec:lex-comment} + +\subsection{Comments} \label{sec:syntax.lex.comment} \begin{grammar} ::= @@ -191,37 +151,35 @@ binary. However, length and signedness indicators are not permitted. ::= any character other than "*" or "/" - ::= "//" @^* + ::= "/\,/" @^* ::= a newline character ::= any character other than newline \end{grammar} -Comments are exactly as in C99: both traditional block comments `\texttt{/*} -\dots\ \texttt{*/}' and \Cplusplus-style `\texttt{//} \dots' comments are -permitted and ignored. +Comments are exactly as in C99: both traditional block comments `@|/*| \dots\ +@|*/|' and \Cplusplus-style `@|/\,/| \dots' comments are permitted and +ignored. -\subsection{Special nonterminals} -\label{sec:special-nonterminals} + +\subsection{Special nonterminals} \label{sec:syntax.lex.special} Aside from the lexical syntax presented above (\xref{sec:lexical-syntax}), two special nonterminals occur in the module syntax. -\subsubsection{S-expressions} \label{sec:syntax-sexp} - +\subsubsection{S-expressions} \begin{grammar} ::= an S-expression, as parsed by the Lisp reader \end{grammar} When an S-expression is expected, the Sod parser simply calls the host Lisp -system's \textsf{read} function. Sod modules are permitted to modify the -read table to extend the S-expression syntax. +system's @|read| function. Sod modules are permitted to modify the read +table to extend the S-expression syntax. S-expressions are self-delimiting, so no end-marker is needed. -\subsubsection{C fragments} \label{sec:syntax.lex.cfrag} - +\subsubsection{C fragments} \begin{grammar} ::= a sequence of C tokens, with matching brackets \end{grammar} @@ -235,7 +193,8 @@ determined by the immediately surrounding context -- usually a closing brace or bracket. The first such delimiter character which is not enclosed in brackets, braces or parenthesis ends the fragment. -\subsection{Module syntax} \label{sec:syntax-module} +%%%-------------------------------------------------------------------------- +\section{Module syntax} \label{sec:syntax.module} \begin{grammar} ::= @^* @@ -248,13 +207,22 @@ brackets, braces or parenthesis ends the fragment. \alt \end{grammar} -A module is the top-level syntactic item. A module consists of a sequence of -definitions. +A @ is the top-level syntactic item. A module consists of a sequence +of definitions. -\subsection{Simple definitions} \label{sec:syntax.defs} +[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} -\subsubsection{Importing modules} \label{sec:syntax.defs.import} +\subsection{Simple definitions} \label{sec:syntax.module.simple} + +\subsubsection{Importing modules} \begin{grammar} ::= "import" ";" \end{grammar} @@ -283,8 +251,7 @@ happens.\footnote{% Recursive imports, either direct or indirect, are an error. -\subsubsection{Loading extensions} \label{sec:syntax.defs.load} - +\subsubsection{Loading extensions} \begin{grammar} ::= "load" ";" \end{grammar} @@ -318,8 +285,7 @@ which will arrange for the extension to be compiled if necessary. particular system definition facility. It's bad enough already that it depends on Common Lisp.) -\subsubsection{Lisp escapes} \label{sec:syntax.defs.lisp} - +\subsubsection{Lisp escapes} \begin{grammar} ::= "lisp" ";" \end{grammar} @@ -334,8 +300,7 @@ The @ is evaluated immediately. It can do anything it likes. this isn't as unusually scary as it sounds. But please be careful.} % \end{boxy} -\subsubsection{Declaring type names} \label{sec:syntax.defs.typename} - +\subsubsection{Declaring type names} \begin{grammar} ::= "typename" $[\mbox{@}]$ ";" @@ -348,16 +313,19 @@ done by distinguishing type names from other identifiers. Don't declare class names using @"typename"; use @"class" forward declarations instead. -\subsection{Literal code} \label{sec:syntax-code} + +\subsection{Literal code} \label{sec:syntax.module.literal} \begin{grammar} ::= - "code" ":" @[@] + "code" ":" @[@] "{" "}" ::= "[" $[\mbox{@}]$ "]" - ::= @^+ + ::= @^+ + + ::= @! "(" @^+ ")" \end{grammar} The @ will be output unchanged to one of the output files. @@ -366,26 +334,27 @@ The first @ is the symbolic name of an output file. Predefined output file names are @"c" and @"h", which are the implementation code and header file respectively; other output files can be defined by extensions. -The second @ provides a name for the output item. Several C -fragments can have the same name: they will be concatenated together in the -order in which they were encountered. +Output items are named with a sequence of identifiers, separated by +whitespace, and enclosed in parentheses. As an abbreviation, a name +consisting of a single identifier may be written as just that identifier, +without the parentheses. The @ provide a means for specifying where in the output file the output item should appear. (Note the two kinds of square brackets shown in the syntax: square brackets must appear around the constraints if they are present, but that they may be omitted.) Each comma-separated @ -is a sequence of identifiers naming output items, and indicates that the -output items must appear in the order given -- though the translator is free -to insert additional items in between them. (The particular output items -needn't be defined already -- indeed, they needn't be defined ever.) +is a sequence of names of output items, and indicates that the output items +must appear in the order given -- though the translator is free to insert +additional items in between them. (The particular output items needn't be +defined already -- indeed, they needn't be defined ever.) There is a predefined output item @"includes" in both the @"c" and @"h" output files which is a suitable place for inserting @"\#include" preprocessor directives in order to declare types and functions for use elsewhere in the generated output files. -\subsection{Property sets} \label{sec:syntax.propset} +\subsection{Property sets} \label{sec:syntax.module.properties} \begin{grammar} ::= "[" $[\mbox{@}]$ "]" @@ -401,17 +370,17 @@ A property has a name, given as an @, and a value computed by evaluating an @. The value can be one of a number of types, though the only operators currently defined act on integer values only. -\subsubsection{The expression evaluator} \label{sec:syntax.propset.expr} - +\subsubsection{The expression evaluator} \begin{grammar} - ::= | "+" | "-" + ::= | "+" | "--" ::= | "*" | "/" - ::= | "+" | "-" + ::= | "+" | "--" ::= | | | +\alt "<" ">" \alt "?" \alt "(" ")" \end{grammar} @@ -429,7 +398,8 @@ causes the @ to be evaluated using the Lisp \textsf{eval} function. %%% FIXME crossref to extension docs -\subsection{C types} \label{sec:syntax.c-types} + +\subsection{C types} \label{sec:syntax.module.types} Sod's syntax for C types closely mirrors the standard C syntax. A C type has two parts: a sequence of @s and a @. In @@ -437,31 +407,55 @@ Sod, a type must contain at least one @ (i.e., `implicit @"int"' is forbidden), and storage-class specifiers are not recognized. -\subsubsection{Declaration specifiers} \label{sec:syntax.c-types.declspec} - +\subsubsection{Declaration specifiers} \begin{grammar} ::= \alt "struct" | "union" | "enum" \alt "void" | "char" | "int" | "float" | "double" \alt "short" | "long" \alt "signed" | "unsigned" +\alt "bool" | "_Bool" +\alt "imaginary" | "_Imaginary" | "complex" | "_Complex" \alt +\alt +\alt - ::= "const" | "volatile" | "restrict" + ::= | "const" | "volatile" | "restrict" + + ::= @^+ + + ::= + "(" ")" + + ::= "atomic" | "_Atomic" + + ::= "(" ")" + + ::= "alignas" "_Alignas" ::= \end{grammar} A @ is an identifier which has been declared as being a type name, -using the @"typename" or @"class" definitions. +using the @"typename" or @"class" definitions. The following type names are +defined in the built-in module. +\begin{itemize} +\item @"va_list" +\item @"size_t" +\item @"ptrdiff_t" +\item @"wchar_t" +\end{itemize} Declaration specifiers may appear in any order. However, not all combinations are permitted. A declaration specifier must consist of zero or -more @, and one of the following, up to reordering. +more @s, zero or more @s, and one of the +following, up to reordering. \begin{itemize} \item @ +\item @ \item @"struct" @, @"union" @, @"enum" @ \item @"void" +\item @"_Bool", @"bool" \item @"char", @"unsigned char", @"signed char" \item @"short", @"unsigned short", @"signed short" \item @"short int", @"unsigned short int", @"signed short int" @@ -471,32 +465,40 @@ more @, and one of the following, up to reordering. \item @"long long", @"unsigned long long", @"signed long long" \item @"long long int", @"unsigned long long int", @"signed long long int" \item @"float", @"double", @"long double" +\item @"float _Imaginary", @"double _Imaginary", @"long double _Imaginary" +\item @"float imaginary", @"double imaginary", @"long double imaginary" +\item @"float _Complex", @"double _Complex", @"long double _Complex" +\item @"float complex", @"double complex", @"long double complex" \end{itemize} All of these have their usual C meanings. -\subsubsection{Declarators} \label{sec:syntax.c-types.declarator} +\subsubsection{Declarators} \begin{grammar} -$[k]$ ::= @^* $[k]$ +$[k, a]$ ::= @^* $[k, a]$ -$[k]$ ::= $k$ -\alt "(" $[k]$ ")" -\alt $[k]$ @ +$[k, a]$ ::= $k$ +\alt "(" $[k, a]$ ")" +\alt $[k, a]$ @$[a]$ ::= "*" @^* - ::= "[" "]" -\alt "(" ")" +$[a]$ ::= "[" "]" +\alt "(" $a$ ")" - ::= $\epsilon$ | "..." -\alt $[\mbox{@}]$ @["," "..."@] + ::= $\epsilon$ | "\dots" +\alt $[\mbox{@}]$ @["," "\dots"@] ::= @^+ + ::= $[\epsilon, \mbox{@}]$ + ::= $[\mbox{@ @! $\epsilon$}]$ - ::= $[\mbox{@}]$ + ::= + $[\mbox{@ @! $\epsilon$}, \mbox{@}]$ - ::= "." + ::= + $[\mbox{@}, \mbox{@}]$ \end{grammar} The declarator syntax is taken from C, but with some differences. @@ -511,14 +513,33 @@ The declarator syntax is taken from C, but with some differences. The remaining differences are (I hope) a matter of presentation rather than substance. -\subsection{Defining classes} \label{sec:syntax.class} +There is additional syntax to support messages and methods which accept +keyword arguments. + +\begin{grammar} + ::= @["=" @] + + ::= + @[$[\mbox{@}]$@] + "?" @[$[\mbox{@}]$@] + + ::= @! + + ::= "." + +$[k]$ ::= + $[k, \mbox{@}]$ +\end{grammar} + + +\subsection{Class definitions} \label{sec:syntax.module.class} \begin{grammar} ::= \alt \end{grammar} -\subsubsection{Forward declarations} \label{sec:class.class.forward} +\subsubsection{Forward declarations} \begin{grammar} ::= "class" ";" \end{grammar} @@ -526,20 +547,19 @@ substance. A @ informs Sod that an @ will be used to name a class which is currently undefined. Forward declarations are necessary in order to resolve certain kinds of circularity. For example, -\begin{listing} -class Sub; +\begin{prog} +class Sub; \\+ -class Super : SodObject { - Sub *sub; -}; +class Super: SodObject \{ \\ \ind + Sub *sub; \-\\ +\}; \\+ -class Sub : Super { - /* ... */ -}; -\end{listing} - -\subsubsection{Full class definitions} \label{sec:class.class.full} +class Sub: Super \{ \\ \ind + /* \dots\ */ \-\\ +\}; +\end{prog} +\subsubsection{Full class definitions} \begin{grammar} ::= @[@] @@ -550,6 +570,8 @@ class Sub : Super { ::= \alt +\alt +\alt \alt \alt \end{grammar} @@ -563,7 +585,10 @@ names, to distinguish them from other kinds of identifiers. The @$[\mbox{@}]$ names the direct superclasses for the new class. It is an error if any of these @s does not name a defined -class. +class. The superclass list is required, and must not be empty; listing +@|SodObject| as your class's superclass is a good choice if nothing else +seems suitable. It's not possible to define a \emph{root class} in the Sod +language: you must use Lisp to do this, and it's quite involved. The @ provide additional information. The standard class properties are as follows. @@ -578,7 +603,7 @@ properties are as follows. which messages it will respond to, and what its behaviour will be when it receives them. The property value must be an identifier naming a defined subclass of @"SodClass". The default metaclass is @"SodClass". - %%% FIXME xref to theory + See \xref{sec:concepts.metaclasses} for more details. \item[@"nick"] A nickname for the class, to be used to distinguish it from other classes in various limited contexts. The property value must be an identifier; the default is constructed by forcing the class name to @@ -588,8 +613,7 @@ properties are as follows. The class body consists of a sequence of @s enclosed in braces. These items are discussed on the following sections. -\subsubsection{Slot items} \label{sec:sntax.class.slot} - +\subsubsection{Slot items} \begin{grammar} ::= @^+ $[\mbox{@}]$ ";" @@ -606,32 +630,40 @@ 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, -\begin{listing} -[nick = eg] -class Example : Super { - int foo = 17; -}; -\end{listing} +\begin{prog} +[nick = eg] \\ +class Example: Super \{ \\ \ind + int foo = 17; \-\\ +\}; +\end{prog} means the same as -\begin{listing} -[nick = eg] -class Example : Super { - int foo; - eg.foo = 17; -}; -\end{listing} - -\subsubsection{Initializer items} \label{sec:syntax.class.init} - +\begin{prog} +[nick = eg] \\ +class Example: Super \{ \\ \ind + int foo; \\ + eg.foo = 17; \-\\ +\}; +\end{prog} + +\subsubsection{Initializer items} \begin{grammar} ::= @["class"@] $[\mbox{@}]$ ";" - ::= "=" + ::= @["=" @] - :: "{" "}" | + :: \end{grammar} An @ provides an initial value for one or more slots. If @@ -642,27 +674,90 @@ 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. -The initializer has one of two forms. -\begin{itemize} -\item A @ enclosed in braces denotes an aggregate initializer. - This is suitable for initializing structure, union or array slots. -\item A @ \emph{not} beginning with an open brace is a `bare' - initializer, and continues until the next @`,' or @`;' which is not within - nested brackets. Bare initializers are suitable for initializing scalar - slots, such as pointers or integers, and strings. -\end{itemize} +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. +\item[@"initarg_class"] A symbol naming the Lisp class to use to represent + the initarg. Only permitted if @"initarg" is also set. +\end{description} + +Each class may define at most one initializer item with an explicit +initializer expression for a given slot. + +\subsubsection{Initarg items} +\begin{grammar} + ::= + "initarg" + @^+ + $[\mbox{@}]$ ";" +\end{grammar} +Properties: +\begin{description} +\item[@"initarg_class"] A symbol naming the Lisp class to use to represent + the initarg. +\end{description} -\subsubsection{Message items} \label{sec:syntax.class.message} +\subsubsection{Fragment items} +\begin{grammar} + ::= "{" "}" + + ::= "init" | "teardown" +\end{grammar} +\subsubsection{Message items} \begin{grammar} ::= @^+ $[\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} -\subsubsection{Method items} \label{sec:syntax.class.method} +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} ::= @^+ @@ -671,6 +766,14 @@ The initializer has one of two forms. ::= "{" "}" | "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 --------------------------------------------------