X-Git-Url: https://gitweb.factorcode.org/gitweb.cgi?p=factor.git;a=blobdiff_plain;f=basis%2Falien%2Fc-types%2Fc-types-docs.factor;h=c425d290edcc173bbcc4ec40f40e5f58043899aa;hp=bf35d968afb8cbe36a92e7ea5e74d5c5558cd5ca;hb=98e31346d3ddd0f54d622e6ec489bdb48e090355;hpb=3f18b71d079f1373d0b23d9446a983cd5bb62c13 diff --git a/basis/alien/c-types/c-types-docs.factor b/basis/alien/c-types/c-types-docs.factor index bf35d968af..c425d290ed 100644 --- a/basis/alien/c-types/c-types-docs.factor +++ b/basis/alien/c-types/c-types-docs.factor @@ -1,7 +1,5 @@ -USING: alien help.syntax help.markup libc kernel.private -byte-arrays strings hashtables alien.syntax alien.strings -sequences io.encodings.string debugger destructors vocabs.loader -classes.struct math kernel ; +USING: alien alien.syntax byte-arrays classes.struct help.markup +help.syntax kernel math sequences ; IN: alien.c-types HELP: heap-size @@ -85,9 +83,9 @@ $nl "Pointer output values are represented in Factor as " { $link alien } "s. If the pointed-to type is a struct, the alien will automatically be wrapped in a struct object if it is not null." $nl "In " { $link POSTPONE: TYPEDEF: } ", " { $link POSTPONE: FUNCTION: } ", " { $link POSTPONE: CALLBACK: } ", and " { $link POSTPONE: STRUCT: } " definitions, pointer types can be created by suffixing " { $snippet "*" } " to a C type name. Outside of FFI definitions, a pointer C type can be created using the " { $link POSTPONE: pointer: } " syntax word:" -{ $unchecked-example "FUNCTION: int* foo ( char* bar ) ;" } +{ $unchecked-example "FUNCTION: int* foo ( char* bar )" } { $unchecked-example ": foo ( bar -- int* ) - pointer: int f \"foo\" { pointer: char } alien-invoke ;" } } ; + pointer: int f \"foo\" { pointer: char } f alien-invoke ;" } } ; ARTICLE: "byte-arrays-gc" "Byte arrays and the garbage collector" "The Factor garbage collector can move byte arrays around, and it is only safe to pass byte arrays to C functions if the garbage collector will not run while C code still has a reference to the data." @@ -105,7 +103,7 @@ $nl ARTICLE: "c-types.primitives" "Primitive C types" "The following numerical types are defined in the " { $vocab-link "alien.c-types" } " vocabulary; a " { $snippet "u" } " prefix denotes an unsigned type:" { $table - { "C type" "Notes" } + { { $strong "C type" } { $strong "Notes" } } { { $link char } "always 1 byte" } { { $link uchar } { } } { { $link short } "always 2 bytes" } @@ -133,26 +131,25 @@ $nl ARTICLE: "c-types.ambiguity" "Word name clashes with C types" "Note that some of the C type word names clash with commonly-used Factor words:" { $list - { { $link short } " clashes with the " { $link sequences:short } " word in the " { $vocab-link "sequences" } " vocabulary" } { { $link float } " clashes with the " { $link math:float } " word in the " { $vocab-link "math" } " vocabulary" } } "If you use the wrong vocabulary, you will see a " { $link no-c-type } " error. For example, the following is " { $strong "not" } " valid, and will raise an error because the " { $link math:float } " word from the " { $vocab-link "math" } " vocabulary is not a C type:" { $code "USING: alien.syntax math prettyprint ;" - "FUNCTION: float magic_number ( ) ;" + "FUNCTION: float magic_number ( )" "magic_number 3.0 + ." } "The following won't work either; now the problem is that there are two vocabularies in the search path that define a word named " { $snippet "float" } ":" { $code "USING: alien.c-types alien.syntax math prettyprint ;" - "FUNCTION: float magic_number ( ) ;" + "FUNCTION: float magic_number ( )" "magic_number 3.0 + ." } "The correct solution is to use one of " { $link POSTPONE: FROM: } ", " { $link POSTPONE: QUALIFIED: } " or " { $link POSTPONE: QUALIFIED-WITH: } " to disambiguate word lookup:" { $code "USING: alien.syntax math prettyprint ;" "QUALIFIED-WITH: alien.c-types c" - "FUNCTION: c:float magic_number ( ) ;" + "FUNCTION: c:float magic_number ( )" "magic_number 3.0 + ." } "See " { $link "word-search-semantics" } " for details." ;