classes.struct vocabulary
Factor handbook » Vocabulary index

Documentation
Struct classes

Metadata

Parents:	classes
Authors:	Joe Groff, Daniel Ehrenberg, John Benediktsson, Slava Pestov

Words

Tuple classes

Class	Superclass	Slots
invalid-struct-slot	tuple	token
struct	tuple	(underlying)
struct-bit-slot-spec	struct-slot-spec	bits signed?
struct-c-type	abstract-c-type	fields return-in-registers?
struct-must-have-slots	tuple
struct-slot-spec	slot-spec	type packed?

Predicate classes

Class	Superclass
struct-class	tuple-class

Parsing words

Word	Syntax
PACKED-STRUCT:	PACKED-STRUCT: class { slot type } { slot type } ... ;
S@	S@ class alien
STRUCT:	STRUCT: class { slot type } { slot type } ... ;
S{	S{ class slots... }
UNION-STRUCT:	UNION-STRUCT: class { slot type } { slot type } ... ;

Generic words

Word	Stack effect
struct-slot-values	( struct -- sequence )

Macro words

Word	Stack effect
<struct-boa>	( class -- quot: ( ... -- struct ) )

Symbol words

bits:

Ordinary words

Word	Stack effect
(malloc-struct)	( class -- struct )
(struct)	( class -- struct )
<struct-slot-spec>	( name c-type attributes -- slot-spec )
<struct>	( class -- struct )
define-packed-struct-class	( class slots -- )
define-struct-class	( class slots -- )
define-union-struct-class	( class slots -- )
invalid-struct-slot	( token -- * )
large-struct?	( type -- ? )
malloc-struct	( class -- struct )
memory>struct	( ptr class -- struct )
offset-of	( field struct -- offset )
read-struct	( class -- struct )
struct-must-have-slots	( -- * )
struct-prototype	( class -- prototype )
struct-size	( class -- n )
struct-slot-class	( c-type -- class' )
struct-slots	( struct-class -- slots )

Class predicate words

Word	Stack effect
invalid-struct-slot?	( object -- ? )
struct-bit-slot-spec?	( object -- ? )
struct-c-type?	( object -- ? )
struct-class?	( object -- ? )
struct-must-have-slots?	( object -- ? )
struct-slot-spec?	( object -- ? )
struct?	( object -- ? )

Files

resource:basis/classes/struct/struct.factor
resource:basis/classes/struct/struct-docs.factor
resource:basis/classes/struct/struct-tests.factor

Metadata files

resource:basis/classes/struct/authors.txt
resource:basis/classes/struct/summary.txt

Children from resource:basis

Vocabulary	Summary
classes.struct.bit-accessors
classes.struct.prettyprint

Children from resource:extra

Vocabulary	Summary
classes.struct.vectored	Derive a tuple of specialized arrays from a struct class