classes.struct vocabulary
Factor handbook » Vocabulary index


Documentation
Struct classes

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


Words

Error classes
ClassSuperclassSlots
Image bad-struct-array-lengthImage tuplevalue expected
Image invalid-struct-slotImage tupletoken
Image struct-must-have-slotsImage tuple


Tuple classes
ClassSuperclassSlots
Image structImage tuple(underlying)
Image struct-bit-slot-specImage struct-slot-specbits signed?
Image struct-c-typeImage abstract-c-typefields return-in-registers?
Image struct-slot-specImage slot-spectype packed?


Predicate classes
ClassSuperclass
Image struct-classImage tuple-class


Parsing words
WordSyntax
Image PACKED-STRUCT:PACKED-STRUCT: class { slot type } { slot type } ... ;
Image S@S@ class alien
Image STRUCT:STRUCT: class { slot type } { slot type } ... ;
Image S{S{ class slots... }
Image UNION-STRUCT:UNION-STRUCT: class { slot type } { slot type } ... ;


Generic words
WordStack effect
Image struct-slot-values( struct -- sequence )


Macro words
WordStack effect
Image <struct-boa>( class -- quot: ( ... -- struct ) )


Symbol words
Image bits:


Ordinary words
WordStack effect
Image (malloc-struct)( class -- struct )
Image (struct)( class -- struct )
Image <struct-slot-spec>( name c-type attributes -- slot-spec )
Image <struct>( class -- struct )
Image bad-struct-array-length( value expected -- * )
Image define-packed-struct-class( class slots -- )
Image define-struct-class( class slots -- )
Image define-union-struct-class( class slots -- )
Image invalid-struct-slot( token -- * )
Image large-struct?( type -- ? )
Image malloc-struct( class -- struct )
Image memory>struct( ptr class -- struct )
Image offset-of( field struct -- offset )
Image read-struct( class -- struct )
Image struct-must-have-slots( -- * )
Image struct-prototype( class -- prototype )
Image struct-size( class -- n )
Image struct-slot-class( c-type -- class' )
Image struct-slots( struct-class -- slots )


Class predicate words
WordStack effect
Image bad-struct-array-length?( object -- ? )
Image invalid-struct-slot?( object -- ? )
Image struct-bit-slot-spec?( object -- ? )
Image struct-c-type?( object -- ? )
Image struct-class?( object -- ? )
Image struct-must-have-slots?( object -- ? )
Image struct-slot-spec?( object -- ? )
Image 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
VocabularySummary
Image classes.struct.bit-accessors
Image classes.struct.prettyprint


Children from resource:extra
VocabularySummary
Image classes.struct.vectoredDerive a tuple of specialized arrays from a struct class