Module description

stc -- ANS Structure module

The stc module implements ANS structures.

ANS Structure syntax words

begin-structure ( "<spaces>name" -- structure-sys ; -- n )

Start definition of a named structure, return the structure size

end-structure ( structure-sys -- )

End a structure definition

ANS field definition words

+field ( structure-sys n "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of size n bytes, return the field address

cfield: ( structure-sys "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of 1 char, return the field address

field: ( structure-sys "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of 1 cell, return the field address

dfield: ( structure-sys "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of 1 double, return the field address

ffield: ( structure-sys "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of 1 float, return the field address

sffield: ( structure-sys "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of 1 single float, return the field address

dffield: ( structure-sys "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of 1 double float, return the field address

Array field definition words

cfields: ( structure-sys n "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of n chars, return the field address

fields: ( structure-sys n "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of n cells, return the field address

dfields: ( structure-sys n "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of n doubles, return the field address

ffields: ( structure-sys n "<spaces>name" -- structure-sys ; addr1 -- addr2 )

Create a structure field of n floats, return the field address

Generated by fsdocgen 0.1.0