diff options
author | Daniel Colascione <[email protected]> | 2014-04-19 19:34:22 -0700 |
---|---|---|
committer | Daniel Colascione <[email protected]> | 2014-04-19 19:34:22 -0700 |
commit | 89a2e783c2f22b4932dd77c16a0e357c5c17a4bf (patch) | |
tree | e3cdb05ac00ce099145ac0205c6ce12da43e7f1d /doc | |
parent | 6dfa19c50f75c1892f5c9a48104ddd532796d089 (diff) |
defstruct introspection
Diffstat (limited to 'doc')
-rw-r--r-- | doc/misc/cl.texi | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi index f0ac289aca..1c20296188 100644 --- a/doc/misc/cl.texi +++ b/doc/misc/cl.texi @@ -4247,6 +4247,46 @@ of the included type and the first new slot. Except as noted, the @code{cl-defstruct} facility of this package is entirely compatible with that of Common Lisp. +The @code{cl-defstruct} package also provides a few structure +introspection functions. + +@defun cl-struct-sequence-type struct-type +This function returns the underlying data structure for +@code{struct-type}, which is a symbol. It returns @code{vector} or +@code{list}, or @code{nil} if @code{struct-type} is not actually a +structure. + +@defun cl-struct-slot-info struct-type +This function returns a list of slot descriptors for structure +@code{struct-type}. Each entry in the list is @code{(name . opts)}, +where @code{name} is the name of the slot and @code{opts} is the list +of slot options given to @code{defstruct}. Dummy entries represent +the slots used for the struct name and that are skipped to implement +@code{:initial-offset}. + +@defun cl-struct-slot-offset struct-type slot-name +Return the offset of slot @code{slot-name} in @code{struct-type}. The +returned zero-based slot index is relative to the start of the +structure data type and is adjusted for any structure name and +:initial-offset slots. Signal error if struct @code{struct-type} does +not contain @code{slot-name}. + +@defun cl-struct-slot-value struct-type slot-name inst +Return the value of slot @code{slot-name} in @code{inst} of +@code{struct-type}. @code{struct} and @code{slot-name} are symbols. +@code{inst} is a structure instance. This routine is also a +@code{setf} place. @code{cl-struct-slot-value} uses +@code{cl-struct-slot-offset} internally and can signal the same +errors. + +@defun cl-struct-set-slot-value struct-type slot-name inst value +Set the value of slot @code{slot-name} in @code{inst} of +@code{struct-type}. @code{struct} and @code{slot-name} are symbols. +@code{inst} is a structure instance. @code{value} is the value to +which to set the given slot. Return @code{value}. +@code{cl-struct-slot-value} uses @code{cl-struct-set-slot-offset} +internally and can signal the same errors. + @node Assertions @chapter Assertions and Errors |