basis/alien/c-types/c-types-docs.factor

   1 USING: alien alien.complex help.syntax help.markup libc kernel.private
   2 byte-arrays strings hashtables alien.syntax alien.strings sequences
   3 io.encodings.string debugger destructors vocabs.loader
   4 classes.struct ;
   5 QUALIFIED: math
   6 QUALIFIED: sequences
   7 IN: alien.c-types
   8
   9 HELP: heap-size
  10 { $values { "name" "a C type name" } { "size" math:integer } }
  11 { $description "Outputs the number of bytes needed for a heap-allocated value of this C type." }
  12 { $examples
  13     { $example "USING: alien alien.c-types prettyprint ;\nint heap-size ." "4" }
  14 }
  15 { $errors "Throws a " { $link no-c-type } " error if the type does not exist." } ;
  16
  17 HELP: stack-size
  18 { $values { "name" "a C type name" } { "size" math:integer } }
  19 { $description "Outputs the number of bytes to reserve on the C stack by a value of this C type. In most cases this is equal to " { $link heap-size } ", except on some platforms where C structs are passed by invisible reference, in which case a C struct type only uses as much space as a pointer on the C stack." }
  20 { $errors "Throws a " { $link no-c-type } " error if the type does not exist." } ;
  21
  22 HELP: <c-type>
  23 { $values { "c-type" c-type } }
  24 { $description "Creates a prototypical C type. User code should use higher-level facilities to define C types; see " { $link "c-data" } "." } ;
  25
  26 HELP: no-c-type
  27 { $values { "name" "a C type name" } }
  28 { $description "Throws a " { $link no-c-type } " error." }
  29 { $error-description "Thrown by " { $link c-type } " if a given string does not name a C type. When thrown during compile time, indicates a typo in an " { $link alien-invoke } " or " { $link alien-callback } " form." } ;
  30
  31 HELP: c-type
  32 { $values { "name" "a C type" } { "c-type" c-type } }
  33 { $description "Looks up a C type by name." }
  34 { $errors "Throws a " { $link no-c-type } " error if the type does not exist, or the word is not a C type." } ;
  35
  36 HELP: c-getter
  37 { $values { "name" "a C type" } { "quot" { $quotation "( c-ptr n -- obj )" } } }
  38 { $description "Outputs a quotation which reads values of this C type from a C structure." }
  39 { $errors "Throws a " { $link no-c-type } " error if the type does not exist." } ;
  40
  41 HELP: c-setter
  42 { $values { "name" "a C type" } { "quot" { $quotation "( obj c-ptr n -- )" } } }
  43 { $description "Outputs a quotation which writes values of this C type to a C structure." }
  44 { $errors "Throws an error if the type does not exist." } ;
  45
  46 HELP: box-parameter
  47 { $values { "n" math:integer } { "c-type" "a C type" } }
  48 { $description "Generates code for converting a C value stored at  offset " { $snippet "n" } " from the top of the stack into a Factor object to be pushed on the data stack." }
  49 { $notes "This is an internal word used by the compiler when compiling callbacks." } ;
  50
  51 HELP: box-return
  52 { $values { "c-type" "a C type" } }
  53 { $description "Generates code for converting a C value stored in return registers into a Factor object to be pushed on the data stack." }
  54 { $notes "This is an internal word used by the compiler when compiling alien calls." } ;
  55
  56 HELP: unbox-return
  57 { $values { "c-type" "a C type" } }
  58 { $description "Generates code for converting a Factor value on the data stack into a C value to be stored in the return registers." }
  59 { $notes "This is an internal word used by the compiler when compiling callbacks." } ;
  60
  61 HELP: define-deref
  62 { $values { "c-type" "a C type" } }
  63 { $description "Defines a word " { $snippet "*name" } " with stack effect " { $snippet "( c-ptr -- value )" } " for reading a value with C type " { $snippet "name" } " stored at an alien pointer." }
  64 { $notes "This is an internal word called when defining C types, there is no need to call it on your own." } ;
  65
  66 HELP: define-out
  67 { $values { "c-type" "a C type" } }
  68 { $description "Defines a word " { $snippet "<" { $emphasis "name" } ">" } " with stack effect " { $snippet "( value -- array )" } ". This word allocates a byte array large enough to hold a value with C type " { $snippet "name" } ", and writes the value at the top of the stack to the array." }
  69 { $notes "This is an internal word called when defining C types, there is no need to call it on your own." } ;
  70
  71 HELP: char
  72 { $description "This C type represents a one-byte signed integer type. Input values will be converted to " { $link math:integer } "s and truncated to eight bits; output values will be returned as " { $link math:fixnum } "s." } ;
  73 HELP: uchar
  74 { $description "This C type represents a one-byte unsigned integer type. Input values will be converted to " { $link math:integer } "s and truncated to eight bits; output values will be returned as " { $link math:fixnum } "s." } ;
  75 HELP: short
  76 { $description "This C type represents a two-byte signed integer type. Input values will be converted to " { $link math:integer } "s and truncated to sixteen bits; output values will be returned as " { $link math:fixnum } "s." } ;
  77 HELP: ushort
  78 { $description "This C type represents a two-byte unsigned integer type. Input values will be converted to " { $link math:integer } "s and truncated to sixteen bits; output values will be returned as " { $link math:fixnum } "s." } ;
  79 HELP: int
  80 { $description "This C type represents a four-byte signed integer type. Input values will be converted to " { $link math:integer } "s and truncated to 32 bits; output values will be returned as " { $link math:integer } "s." } ;
  81 HELP: uint
  82 { $description "This C type represents a four-byte unsigned integer type. Input values will be converted to " { $link math:integer } "s and truncated to 32 bits; output values will be returned as " { $link math:integer } "s." } ;
  83 HELP: long
  84 { $description "This C type represents a four- or eight-byte signed integer type. On Windows and on 32-bit Unix platforms, it will be four bytes. On 64-bit Unix platforms, it will be eight bytes. Input values will be converted to " { $link math:integer } "s and truncated to 32 or 64 bits; output values will be returned as " { $link math:integer } "s." } ;
  85 HELP: intptr_t
  86 { $description "This C type represents a signed integer type large enough to hold any pointer value; that is, on 32-bit platforms, it will be four bytes, and on 64-bit platforms, it will be eight bytes. Input values will be converted to " { $link math:integer } "s and truncated to 32 or 64 bits; output values will be returned as " { $link math:integer } "s." } ;
  87 HELP: ulong
  88 { $description "This C type represents a four- or eight-byte unsigned integer type. On Windows and on 32-bit Unix platforms, it will be four bytes. On 64-bit Unix platforms, it will be eight bytes. Input values will be converted to " { $link math:integer } "s and truncated to 32 or 64 bits; output values will be returned as " { $link math:integer } "s." } ;
  89 HELP: uintptr_t
  90 { $description "This C type represents an unsigned integer type large enough to hold any pointer value; that is, on 32-bit platforms, it will be four bytes, and on 64-bit platforms, it will be eight bytes. Input values will be converted to " { $link math:integer } "s and truncated to 32 or 64 bits; output values will be returned as " { $link math:integer } "s." } ;
  91 HELP: ptrdiff_t
  92 { $description "This C type represents a signed integer type large enough to hold the distance between two pointer values; that is, on 32-bit platforms, it will be four bytes, and on 64-bit platforms, it will be eight bytes. Input values will be converted to " { $link math:integer } "s and truncated to 32 or 64 bits; output values will be returned as " { $link math:integer } "s." } ;
  93 HELP: size_t
  94 { $description "This C type represents unsigned size values of the size expected by the platform's standard C library (usually four bytes on a 32-bit platform, and eight on a 64-bit platform). Input values will be converted to " { $link math:integer } "s and truncated to the appropriate size; output values will be returned as " { $link math:integer } "s." } ;
  95 HELP: longlong
  96 { $description "This C type represents an eight-byte signed integer type. Input values will be converted to " { $link math:integer } "s and truncated to 64 bits; output values will be returned as " { $link math:integer } "s." } ;
  97 HELP: ulonglong
  98 { $description "This C type represents an eight-byte unsigned integer type. Input values will be converted to " { $link math:integer } "s and truncated to 64 bits; output values will be returned as " { $link math:integer } "s." } ;
  99 HELP: void
 100 { $description "This symbol is not a valid C type, but it can be used as the return type for a " { $link POSTPONE: FUNCTION: } " or " { $link POSTPONE: CALLBACK: } " definition or for an " { $link alien-invoke } " or " { $link alien-callback } " call." } ;
 101 HELP: void*
 102 { $description "This C type represents a generic pointer to C memory. See " { $link pointer } " for information on pointer C types." } ;
 103 HELP: c-string
 104 { $description "This C type represents a pointer to a C string. See " { $link "c-strings" } " for details about using strings with the FFI." } ;
 105 HELP: float
 106 { $description "This C type represents a single-precision IEEE 754 floating-point type. Input values will be converted to Factor " { $link math:float } "s and demoted to single-precision; output values will be returned as Factor " { $link math:float } "s." } ;
 107 HELP: double
 108 { $description "This C type represents a double-precision IEEE 754 floating-point type. Input values will be converted to Factor " { $link math:float } "s; output values will be returned as Factor " { $link math:float } "s." } ;
 109 HELP: complex-float
 110 { $description "This C type represents a single-precision IEEE 754 floating-point complex type. Input values will be converted from Factor " { $link math:complex } " objects into a single-precision complex float type; output values will be returned as Factor " { $link math:complex } " objects." } ;
 111 HELP: complex-double
 112 { $description "This C type represents a double-precision IEEE 754 floating-point complex type. Input values will be converted from Factor " { $link math:complex } " objects into a double-precision complex float type; output values will be returned as Factor " { $link math:complex } " objects." } ;
 113
 114 HELP: pointer:
 115 { $syntax "pointer: c-type" }
 116 { $description "Constructs a " { $link pointer } " C type." } ;
 117
 118 HELP: pointer
 119 { $class-description "Represents a pointer C type. The " { $snippet "to" } " slot contains the C type being pointed to." { $link byte-array } " and " { $link alien } " values can be provided as pointer function inputs, but see " { $link "byte-arrays-gc" } " for notes about passing byte arrays into C functions. Objects with methods on " { $link >c-ptr } ", such as structs and specialized arrays, may also be used as pointer inputs."
 120 $nl
 121 "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."
 122 $nl
 123 "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:"
 124 { $unchecked-example "FUNCTION: int* foo ( char* bar ) ;" }
 125 { $unchecked-example """: foo ( bar -- int* )
 126     pointer: int f \"foo\" { pointer: char } alien-invoke ;""" } } ;
 127
 128 ARTICLE: "byte-arrays-gc" "Byte arrays and the garbage collector"
 129 "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."
 130 $nl
 131 "In particular, a byte array can only be passed as a parameter if the the C function does not use the parameter after one of the following occurs:"
 132 { $list
 133     "the C function returns"
 134     "the C function calls Factor code via a callback"
 135 }
 136 "Returning from C to Factor, as well as invoking Factor code via a callback, may trigger garbage collection, and if the function had stored a pointer to the byte array somewhere, this pointer may cease to be valid."
 137 $nl
 138 "If this condition is not satisfied, " { $link "malloc" } " must be used instead."
 139 { $warning "Failure to comply with these requirements can lead to crashes, data corruption, and security exploits." } ;
 140
 141 ARTICLE: "c-out-params" "Output parameters in C"
 142 "A frequently-occurring idiom in C code is the \"out parameter\". If a C function returns more than one value, the caller passes pointers of the correct type, and the C function writes its return values to those locations."
 143 $nl
 144 "Each numerical C type, together with " { $snippet "void*" } ", has an associated " { $emphasis "out parameter constructor" } " word which takes a Factor object as input, constructs a byte array of the correct size, and converts the Factor object to a C value stored into the byte array:"
 145 { $subsections
 146     <char>
 147     <uchar>
 148     <short>
 149     <ushort>
 150     <int>
 151     <uint>
 152     <long>
 153     <ulong>
 154     <longlong>
 155     <ulonglong>
 156     <float>
 157     <double>
 158     <void*>
 159 }
 160 "You call the out parameter constructor with the required initial value, then pass the byte array to the C function, which receives a pointer to the start of the byte array's data area. The C function then returns, leaving the result in the byte array; you read it back using the next set of words:"
 161 { $subsections
 162     *char
 163     *uchar
 164     *short
 165     *ushort
 166     *int
 167     *uint
 168     *long
 169     *ulong
 170     *longlong
 171     *ulonglong
 172     *float
 173     *double
 174     *void*
 175 }
 176 "Note that while structure and union types do not get these words defined for them, there is no loss of generality since " { $link <void*> } " and " { $link *void* } " may be used." ;
 177
 178 ARTICLE: "c-types.primitives" "Primitive C types"
 179 "The following numerical types are defined in the " { $vocab-link "alien.c-types" } " vocabulary; a " { $snippet "u" } " prefix denotes an unsigned type:"
 180 { $table
 181     { "C type" "Notes" }
 182     { { $link char } "always 1 byte" }
 183     { { $link uchar } { } }
 184     { { $link short } "always 2 bytes" }
 185     { { $link ushort } { } }
 186     { { $link int } "always 4 bytes" }
 187     { { $link uint } { } }
 188     { { $link long } { "same size as CPU word size and " { $link void* } ", except on 64-bit Windows, where it is 4 bytes" } }
 189     { { $link ulong } { } }
 190     { { $link longlong } "always 8 bytes" }
 191     { { $link ulonglong } { } }
 192     { { $link float } { "single-precision float (not the same as Factor's " { $link math:float } " class!)" } }
 193     { { $link double } { "double-precision float (the same format as Factor's " { $link math:float } " objects)" } }
 194 }
 195 "The following C99 complex number types are defined in the " { $vocab-link "alien.complex" } " vocabulary:"
 196 { $table
 197     { { $link complex-float } { "C99 or Fortran " { $snippet "complex float" } " type, converted to and from Factor " { $link math:complex } " values" } }
 198     { { $link complex-double } { "C99 or Fortran " { $snippet "complex double" } " type, converted to and from Factor " { $link math:complex } " values" } }
 199 }
 200 "When making alien calls, Factor numbers are converted to and from the above types in a canonical way. Converting a Factor number to a C value may result in a loss of precision." ;
 201
 202 ARTICLE: "c-types.pointers" "Pointer and array types"
 203 "Pointer types are specified by suffixing a C type with " { $snippet "*" } ", for example " { $snippet "float*" } ". One special case is " { $link void* } ", which denotes a generic pointer; " { $link void } " by itself is not a valid C type specifier. This syntax constructs a " { $link pointer } " object to represent the C type."
 204 $nl
 205 "Fixed-size array types are supported; the syntax consists of a C type name followed by dimension sizes in brackets; the following denotes a 3 by 4 array of integers:"
 206 { $code "int[3][4]" }
 207 "Fixed-size arrays differ from pointers in that they are allocated inside structures and unions; however, when used as function parameters, they behave exactly like pointers with the dimensions only serving as documentation." ;
 208
 209 ARTICLE: "c-types.ambiguity" "Word name clashes with C types"
 210 "Note that some of the C type word names clash with commonly-used Factor words:"
 211 { $list
 212   { { $link short } " clashes with the " { $link sequences:short } " word in the " { $vocab-link "sequences" } " vocabulary" }
 213   { { $link float } " clashes with the " { $link math:float } " word in the " { $vocab-link "math" } " vocabulary" }
 214 }
 215 "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:"
 216 { $code
 217   "USING: alien.syntax math prettyprint ;"
 218   "FUNCTION: float magic_number ( ) ;"
 219   "magic_number 3.0 + ."
 220 }
 221 "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" } ":"
 222 { $code
 223   "USING: alien.c-types alien.syntax math prettyprint ;"
 224   "FUNCTION: float magic_number ( ) ;"
 225   "magic_number 3.0 + ."
 226 }
 227 "The correct solution is to use one of " { $link POSTPONE: FROM: } ", " { $link POSTPONE: QUALIFIED: } " or " { $link POSTPONE: QUALIFIED-WITH: } " to disambiguate word lookup:"
 228 { $code
 229   "USING: alien.syntax math prettyprint ;"
 230   "QUALIFIED-WITH: alien.c-types c"
 231   "FUNCTION: c:float magic_number ( ) ;"
 232   "magic_number 3.0 + ."
 233 }
 234 "See " { $link "word-search-semantics" } " for details." ;
 235
 236 ARTICLE: "c-types.structs" "Struct and union types"
 237 "Struct and union types are identified by their class word. See " { $link "classes.struct" } "." ;
 238
 239 ARTICLE: "c-types-specs" "C type specifiers"
 240 "C types are identified by special words. Type names occur as parameters to the " { $link alien-invoke } ", " { $link alien-indirect } " and " { $link alien-callback } " words."
 241 $nl
 242 "Defining new C types:"
 243 { $subsections
 244     POSTPONE: STRUCT:
 245     POSTPONE: UNION-STRUCT:
 246     POSTPONE: CALLBACK:
 247     POSTPONE: TYPEDEF:
 248 }
 249 { $heading "Related articles" }
 250 { $subsections
 251     "c-types.primitives"
 252     "c-types.pointers"
 253     "c-types.ambiguity"
 254     "c-types.structs"
 255 }
 256 ;
 257
 258 ABOUT: "c-types-specs"