steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document struct arrays

db4
Slava Pestov 2008-12-03 09:45:42 -06:00
parent c6f214f60d
commit fdbf623bd4
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
basis/struct-arrays/struct-arrays-docs.factor Normal file
View File

@ -0,0 +1,23 @@
IN: struct-arrays
USING: help.markup help.syntax alien strings math ;
HELP: struct-array
{ $class-description "The class of C struct and union arrays."
$nl
"The " { $slot "underlying" } " slot holds a " { $link c-ptr } " with the raw data. This pointer can be passed to C functions." } ;
HELP: <struct-array>
{ $values { "length" integer } { "c-type" string } }
{ $description "Creates a new array for holding values of the specified C type." } ;
HELP: <direct-struct-array>
{ $values { "alien" c-ptr } { "length" integer } { "c-type" string } }
{ $description "Creates a new array for holding values of the specified C type, backed by the memory at " { $snippet "alien" } "." } ;
ARTICLE: "struct-arrays" "C struct and union arrays"
"The " { $vocab-link "struct-arrays" } " vocabulary implements arrays specialized for holding C struct and union values."
{ $subsection struct-array }
{ $subsection <struct-array> }
{ $subsection <direct-struct-array> } ;
ABOUT: "struct-arrays"