From: Mark Wooding Date: Sat, 2 Jan 2016 15:29:23 +0000 (+0000) Subject: doc/runtime.tex: Demote the object-system support stuff to a section. X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/sod/commitdiff_plain/e520bc2484f96c38991fb8d3b49cd9a3b2410842 doc/runtime.tex: Demote the object-system support stuff to a section. There will be more sections later. --- diff --git a/doc/runtime.tex b/doc/runtime.tex index c1b009f..8b8e080 100644 --- a/doc/runtime.tex +++ b/doc/runtime.tex @@ -25,17 +25,29 @@ \chapter{The runtime library} \label{ch:runtime} -This chapter describes the runtime support macros and functions defined in -the @|| header file. The corresponding types are defined in -\xref{ch:structures}. +This chapter describes the runtime support macros and functions provided by +the Sod library. The common structure of object instances and classes is +described in \xref{ch:structures}. + +%%%-------------------------------------------------------------------------- +\section{Object system support} \label{sec:runtime.object} + +This section describes the macros and functions exposed in the @|| +header file which provide assistance for working with Sod classes and +objects. The runtime support functionality defined here generally expects that instances and classes inherit from the standard @|SodObject| root object. While the translator can (at some effort) support alternative roots, they will require different run-time support machinery. -%%%-------------------------------------------------------------------------- -\section{Infrastructure macros} \label{ch:runtime.infra} + +\subsection{Infrastructure macros} \label{ch:runtime.object.infra} + +The runtime support functionality defined here generally expects that +instances and classes inherit from the standard @|SodObject| root object. +While the translator can (at some effort) support alternative roots, they +will require different run-time support machinery. These macros are mostly intended for use in code generated by the Sod translator. Others may find them useful for special effects, but they can be @@ -87,8 +99,8 @@ general use. @|SOD_INSTBASE| macro (described below) is more suited to general use. \end{describe} -%%%-------------------------------------------------------------------------- -\section{Utility macros} \label{sec:runtime.utility} + +\subsection{Utility macros} \label{sec:runtime.object.utility} The following macros are expected to be useful in Sod method definitions and client code. @@ -144,8 +156,8 @@ client code. invalid when control exits the scope of the declaration. \end{describe} -%%%-------------------------------------------------------------------------- -\section{Functions} \label{sec:runtime.functions} + +\subsection{Functions} \label{sec:runtime.object.functions} The following functions are provided in @|libsod|.