X-Git-Url: https://git.distorted.org.uk/~mdw/sod/blobdiff_plain/e0808c472145fc81e52898bc9ac289e10c4f4f41..e895be217c3be6769708da17c9ae87cb22db040e:/doc/meta.tex diff --git a/doc/meta.tex b/doc/meta.tex index 52a89cf..67e77b2 100644 --- a/doc/meta.tex +++ b/doc/meta.tex @@ -29,15 +29,17 @@ \section{Base metaobject classes} \label{sec:meta.classes} \begin{describe}{cls} - {sod-class () \\ \ind - \&key \=:name :nick :location :pset \+ \\ - :superclasses :link :metaclass \\ + {sod-class () \\ \ind + \&key \=:name :nick :location :pset \+\\ + :superclasses :link :metaclass \\ :slots :instance-initializers :class-initializers \\ + :initargs :initfrags :tearfrags \\ :messages :methods} \end{describe} \begin{describe*} {\dhead{gf}{sod-class-name @ @> @} + \dhead{meth}{sod-class}{file-location (@ sod-class) @> @} \dhead{gf}{sod-class-nickname @ @> @} \dhead{gf}{sod-class-direct-superclasses @ @> @} \dhead{gf}{sod-class-chain-link @ @> @} @@ -48,49 +50,44 @@ \dhead{gf}{setf (sod-class-instance-initializers @) @} \dhead{gf}{sod-class-class-initializers @ @> @} \dhead{gf}{setf (sod-class-class-initializers @) @} + \dhead{gf}{sod-class-initargs @ @> @} + \dhead{gf}{setf (sod-class-initargs @) @} + \dhead{gf}{sod-class-initfrags @ @> @} + \dhead{gf}{setf (sod-class-initfrags @) @} + \dhead{gf}{sod-class-tearfrags @ @> @} + \dhead{gf}{setf (sod-class-tearfrags @) @} \dhead{gf}{sod-class-messages @ @> @} \dhead{gf}{setf (sod-class-messages @) @} \dhead{gf}{sod-class-methods @ @> @} \dhead{gf}{setf (sod-class-methods @) @}} \end{describe*} -%% layout protocol -\begin{describe*} - {\dhead{gf}{sod-class-ilayout @> @} - \dhead{gf}{sod-class-effective-methods @ @> @} - \dhead{gf}{sod-class-vtables @ @> @}} -\end{describe*} - -\begin{describe}{gf}{guess-metaclass @ @> @} +\begin{describe}{fun} + {make-sod-class @ @ @ \&key :location + @> @} \end{describe} \begin{describe}{fun} - {make-sod-class @ @ @ \&optional @ - @> @} + {find-superclass-by-nick @ @ @> @} \end{describe} -\begin{describe}{mac} - {define-sod-class @ (@^*) \\ \ind - @{ @ @ @}^* \\ - @^* \\ - @
^*} +\begin{describe}{ty}{inheritance-path-reporter-state} \end{describe} -\begin{describe*} - {\dhead{lmac}{slot @ @ @{ @ @ @}^*} - \dhead{lmac}{instance-initializer @ @ - @ @ - @{ @ @ @}^*} - \dhead{lmac}{class-initializer @ @ - @ @ - @{ @ @ @}^*} - \dhead{lmac}{message @ @ @{ @ @ @}^*} - \dhead{lmac}{method @ @ @ @ - @{ @ @ @}^*}} -\end{describe*} +\begin{describe}{fun}{make-inheritance-path-reporter-state @> @} +\end{describe} + +\begin{describe}{fun}{report-inheritance-path @ @} +\end{describe} \begin{describe}{fun} - {find-superclass-by-nick @ @ @> @} + {select-minimal-class-property + \=@ @ @ @ @ \\ + \>\&key :present :allow-empty + \nlret @} +\end{describe} + +\begin{describe}{gf}{guess-metaclass @ @> @} \end{describe} \begin{describe}{fun} @@ -111,12 +108,13 @@ \begin{describe*} {\dhead{gf}{sod-slot-name @ @> @} + \dhead{meth}{sod-slot}{file-location (@ sod-slot) @> @} \dhead{gf}{sod-slot-class @ @> @} \dhead{gf}{sod-slot-type @ @> @}} \end{describe*} \begin{describe}{gf} - {make-sod-slot @ @ @ @ \&optional @ + {make-sod-slot @ @ @ @ \&key :location @> @} \end{describe} @@ -129,13 +127,8 @@ @> @}} \end{describe*} -\begin{describe}{fun} - {find-instance-slot-by-name @ @ @ - @> @} -\end{describe} - \begin{describe}{cls} - {sod-class-slot (sod-slot) \\ \ind + {sod-class-slot (sod-slot) \\ \ind \&key :name :location :pset :class :type :initializer-function :prepare-function} \end{describe} @@ -147,50 +140,97 @@ \begin{describe*} {\dhead{cls}{sod-initializer () - \&key :slot :location :class :value-kind :value-form} + \&key :slot :location :class :value} \dhead{cls}{sod-instance-initializer (sod-initializer) - \&key :slot :location :class :value-kind :value-form} + \&key :slot :location :class :value} \dhead{cls}{sod-class-initializer (sod-initializer) - \&key :slot :location :class :value-kind :value-form}} + \&key :slot :location :class :value}} \end{describe*} \begin{describe*} {\dhead{gf}{sod-initializer-slot @ @> @} - \dhead{gf}{sod-initializer-value-kind @ @> @} - \dhead{gf}{sod-initializer-value-form @ @> @}} + \dhead{meth}{sod-initializer} + {file-location (@ sod-initializer) @> @} + \dhead{gf}{sod-initializer-value @ @> @} + \dhead{gf}{sod-initializer-class @ @> @}} \end{describe*} \begin{describe*} {\dhead{gf} - {make-slot-instance-initializer \=@ @ @ - @ @ \+ \\ - @ \&optional @ \- + {make-sod-instance-initializer + \=@ @ @ @ @ \\ + \>\&key :inhibit-initargs :location \nlret @} \dhead{gf} - {make-slot-class-initializer \=@ @ @ - @ @ \+ \\ - @ \&optional @ \- + {make-sod-class-initializer + \=@ @ @ @ @ \&key :location \nlret @}} \end{describe*} \begin{describe}{gf} - {make-sod-initializer-using-slot \=@ @ @ - @ @ \+ \\ - @ \&optional @ \- + {make-sod-initializer-using-slot + @ @ @ @ @ @ \nlret @} \end{describe} -\begin{describe}{cls}{sod-message () \&key :name :location :class :type} +\begin{describe*} + {\dhead{cls}{sod-initarg () \&key :class :location :name :type} + \dhead{cls}{sod-user-initarg (sod-initarg) + \&key :class :location :name :type :default} + \dhead{cls}{sod-slot-initarg (sod-initarg) + \&key :class :location :name :type :slot}} +\end{describe*} + +\begin{describe*} + {\dhead{gf}{sod-initarg-class @ @> @} + \dhead{gf}{sod-initarg-name @ @> @} + \dhead{gf}{sod-initarg-type @ @> @} + \dhead{gf}{sod-initarg-default @ @> @} + \dhead{gf}{sod-initarg-slot @ @> @}} +\end{describe*} + +\begin{describe}{gf}{sod-initarg-argument @ @> @} +\end{describe} + +\begin{describe}{gf} + {make-sod-user-initarg @ @ @ @ + \&key :default :location + \nlret @} +\end{describe} + +\begin{describe*} + {\dhead{gf} + {make-sod-slot-initarg @ @ @ @ @ + \&key :location + \nlret @} + \dhead{gf} + {make-sod-slot-initarg-using-slot @ @ @ @ + \&key :location + \nlret @}} +\end{describe*} + +\begin{describe*} + {\dhead{gf}{make-sod-class-initfrag @ @ @ + \&key :location} + \dhead{gf}{make-sod-class-tearfrag @ @ @ + \&key :location}} +\end{describe*} + +\begin{describe}{cls} + {sod-message () \&key :name :location :readonly :class :type} \end{describe} \begin{describe*} {\dhead{gf}{sod-message-name @ @> @} + \dhead{meth}{sod-message} + {file-location (@ sod-message) @> @} + \dhead{gf}{sod-message-readonly-p @ @> @} \dhead{gf}{sod-message-class @ @> @} \dhead{gf}{sod-message-type @ @> @}} \end{describe*} \begin{describe}{gf} - {make-sod-message @ @ @ @ \&optional @ + {make-sod-message @ @ @ @ \&key :location @> @} \end{describe} @@ -208,21 +248,25 @@ \begin{describe*} {\dhead{gf}{sod-method-message @ @> @} + \dhead{meth}{sod-method} + {file-location (@ sod-method) @> @} \dhead{gf}{sod-method-class @ @> @} \dhead{gf}{sod-method-type @ @> @} \dhead{gf}{sod-method-body @ @> @}} \end{describe*} \begin{describe}{gf} - {make-sod-method \=@ @ @ @ @ \+ \\ - @ \&optional @ \- + {make-sod-method + \=@ @ @ @ @ \+\\ + @ \&key :location \- \nlret @} \end{describe} \begin{describe}{gf} - {make-sod-method-using-message \=@ @ - @ @ \+ \\ - @ \&optional @ \- + {make-sod-method-using-message + \=@ @ + @ @ \+\\ + @ \&key :location \- \nlret @} \end{describe} @@ -238,11 +282,32 @@ @> @} \end{describe} +\begin{describe}{fun}{check-method-return-type @ @} +\end{describe} + +\begin{describe}{fun} + {check-method-return-type-against-message @ @} +\end{describe} + +\begin{describe}{fun} + {check-method-argument-lists @ @} +\end{describe} + %%%-------------------------------------------------------------------------- \section{Class finalization protocol} \label{sec:meta.finalization} +\begin{describe}{mac} + {finalization-error (@ @^*) \\ \ind + @^* \\ + @^* \- + \nlret @^*} +\end{describe} + +\begin{describe}{fun}{finalization-failed} +\end{describe} + \begin{describe*} - {\dhead{gf}{sod-class-precedence-list @> @} + {\dhead{gf}{sod-class-precedence-list @ @> @} \dhead{gf}{sod-class-type @ @> @} \dhead{gf}{sod-class-chain-head @ @> @} \dhead{gf}{sod-class-chain @ @> @} @@ -253,13 +318,36 @@ \begin{describe}{gf}{compute-cpl @ @> @} \end{describe} +\begin{describe}{fun} + {report-class-list-merge-error @ @ @} +\end{describe} + +\begin{describe}{fun}{merge-class-lists @ @ @ @> @} +\end{describe} + \begin{describe}{gf}{compute-chains @ @> @} \end{describe} +\begin{describe}{gf}{check-class-initializer @ @} + \begin{describe}{meth}{effective-slot,sod-class} + {check-class-initializer (@ effective-slot) (@ sod-class)} + \end{describe} + \begin{describe}{meth}{sod-class-effective-slot,sod-class} + {check-class-initializer (@ sod-class-effective-slot) + (@ sod-class)} + \end{describe} +\end{describe} + \begin{describe}{gf}{check-sod-class @} \end{describe} -\begin{describe}{gf}{finalize-sod-class @} +\begin{describe}{gf}{finalize-sod-class @ @> @} + \begin{describe}{meth}{sod-class} + {finalize-sod-class (@ sod-class)} + \end{describe} + \begin{describe}{ar-meth}{sod-class} + {finalize-sod-class (@ sod-class) @> @} + \end{describe} \end{describe} \begin{describe}{fun}{clos-cpl @ @> @} @@ -279,6 +367,7 @@ \begin{describe}{fun}{l*loops-cpl @ @> @} \end{describe} + %%%----- That's all, folks -------------------------------------------------- %%% Local variables: