basis/alien/data/data-docs.factor

   1 USING: alien alien.c-types help.syntax help.markup libc
   2 kernel.private byte-arrays math strings hashtables alien.syntax
   3 alien.strings sequences io.encodings.string debugger destructors
   4 vocabs.loader classes.struct ;
   5 IN: alien.data
   6
   7 HELP: <c-array>
   8 { $values { "len" "a non-negative integer" } { "c-type" "a C type" } { "array" byte-array } }
   9 { $description "Creates a byte array large enough to hold " { $snippet "n" } " values of a C type." }
  10 { $notes "The appropriate specialized array vocabulary must be loaded; otherwise, an error will be thrown. The vocabulary can be loaded with the " { $link require-c-array } " word. See the " { $vocab-link "specialized-arrays" } " vocabulary for details on the underlying sequence type constructed." }
  11 { $errors "Throws an error if the type does not exist, the necessary specialized array vocabulary is not loaded, or the requested size is negative." } ;
  12
  13 HELP: <c-object>
  14 { $values { "type" "a C type" } { "array" byte-array } }
  15 { $description "Creates a byte array suitable for holding a value with the given C type." }
  16 { $errors "Throws an " { $link no-c-type } " error if the type does not exist." } ;
  17
  18 { <c-object> malloc-object } related-words
  19
  20 HELP: memory>byte-array
  21 { $values { "alien" c-ptr } { "len" "a non-negative integer" } { "byte-array" byte-array } }
  22 { $description "Reads " { $snippet "len" } " bytes starting from " { $snippet "base" } " and stores them in a new byte array." } ;
  23
  24 HELP: byte-array>memory
  25 { $values { "byte-array" byte-array } { "base" c-ptr } }
  26 { $description "Writes a byte array to memory starting from the " { $snippet "base" } " address." }
  27 { $warning "This word is unsafe. Improper use can corrupt memory." } ;
  28
  29 HELP: malloc-array
  30 { $values { "n" "a non-negative integer" } { "type" "a C type" } { "array" "a specialized array" } }
  31 { $description "Allocates an unmanaged memory block large enough to hold " { $snippet "n" } " values of a C type, then wraps the memory in a sequence object using " { $link <c-direct-array> } "." }
  32 { $notes "The appropriate specialized array vocabulary must be loaded; otherwise, an error will be thrown. The vocabulary can be loaded with the " { $link require-c-array } " word. See the " { $vocab-link "specialized-arrays" } " vocabulary for details on the underlying sequence type constructed." }
  33 { $warning "Don't forget to deallocate the memory with a call to " { $link free } "." }
  34 { $errors "Throws an error if the type does not exist, if the requested size is negative, if a direct specialized array class appropriate to the type is not loaded, or if memory allocation fails." } ;
  35
  36 HELP: malloc-object
  37 { $values { "type" "a C type" } { "alien" alien } }
  38 { $description "Allocates an unmanaged memory block large enough to hold a value of a C type." }
  39 { $warning "Don't forget to deallocate the memory with a call to " { $link free } "." }
  40 { $errors "Throws an error if the type does not exist or if memory allocation fails." } ;
  41
  42 HELP: malloc-byte-array
  43 { $values { "byte-array" byte-array } { "alien" alien } }
  44 { $description "Allocates an unmanaged memory block of the same size as the byte array, and copies the contents of the byte array there." }
  45 { $warning "Don't forget to deallocate the memory with a call to " { $link free } "." }
  46 { $errors "Throws an error if memory allocation fails." } ;
  47
  48 { <c-array> <c-direct-array> malloc-array } related-words
  49
  50 { string>alien alien>string malloc-string } related-words
  51
  52 ARTICLE: "malloc" "Manual memory management"
  53 "Sometimes data passed to C functions must be allocated at a fixed address. See " { $link "byte-arrays-gc" } " for an explanation of when this is the case."
  54 $nl
  55 "Allocating a C datum with a fixed address:"
  56 { $subsections
  57     malloc-object
  58     malloc-byte-array
  59 }
  60 "The " { $vocab-link "libc" } " vocabulary defines several words which directly call C standard library memory management functions:"
  61 { $subsections
  62     malloc
  63     calloc
  64     realloc
  65 }
  66 "You must always free pointers returned by any of the above words when the block of memory is no longer in use:"
  67 { $subsections free }
  68 "Utilities for automatically freeing memory in conjunction with " { $link with-destructors } ":"
  69 { $subsections
  70     &free
  71     |free
  72 }
  73 "The " { $link &free } " and " { $link |free } " words are generated using " { $link "alien.destructors" } "."
  74 $nl
  75 "You can unsafely copy a range of bytes from one memory location to another:"
  76 { $subsections memcpy }
  77 "You can copy a range of bytes from memory into a byte array:"
  78 { $subsections memory>byte-array }
  79 "You can copy a byte array to memory unsafely:"
  80 { $subsections byte-array>memory } ;
  81
  82 ARTICLE: "c-pointers" "Passing pointers to C functions"
  83 "The following Factor objects may be passed to C function parameters with pointer types:"
  84 { $list
  85     { "Instances of " { $link alien } "." }
  86     { "Instances of " { $link f } "; this is interpreted as a null pointer." }
  87     { "Instances of " { $link byte-array } "; the C function receives a pointer to the first element of the array." }
  88     { "Any data type which defines a method on " { $link >c-ptr } " that returns an instance of one of the above. This includes " { $link "classes.struct" } " and " { $link "specialized-arrays" } "." }
  89 }
  90 "The class of primitive C pointer types:"
  91 { $subsections c-ptr }
  92 "A generic word for converting any object to a C pointer; user-defined types may add methods to this generic word:"
  93 { $subsections >c-ptr }
  94 "More about the " { $link alien } " type:"
  95 { $subsections "aliens" }
  96 { $warning
  97 "The Factor garbage collector can move byte arrays around, and code passing byte arrays, or objects backed by byte arrays, must obey important guidelines. See " { $link "byte-arrays-gc" } "." } ;
  98
  99 ARTICLE: "c-data" "Passing data between Factor and C"
 100 "Two defining characteristics of Factor are dynamic typing and automatic memory management, which are somewhat incompatible with the machine-level data model exposed by C. Factor's C library interface defines its own set of C data types, distinct from Factor language types, together with automatic conversion between Factor values and C types. For example, C integer types must be declared and are fixed-width, whereas Factor supports arbitrary-precision integers."
 101 $nl
 102 "Furthermore, Factor's garbage collector can move objects in memory; for a discussion of the consequences, see " { $link "byte-arrays-gc" } "."
 103 { $subsections
 104     "c-types-specs"
 105     "c-pointers"
 106     "malloc"
 107     "c-strings"
 108     "c-out-params"
 109 }
 110 "Important guidelines for passing data in byte arrays:"
 111 { $subsections "byte-arrays-gc" }
 112 "C-style enumerated types are supported:"
 113 { $subsections POSTPONE: C-ENUM: }
 114 "C types can be aliased for convenience and consitency with native library documentation:"
 115 { $subsections POSTPONE: TYPEDEF: }
 116 "A utility for defining " { $link "destructors" } " for deallocating memory:"
 117 { $subsections "alien.destructors" }
 118 "C struct and union types can be defined with " { $link POSTPONE: STRUCT: } " and " { $link POSTPONE: UNION: } ". See " { $link "classes.struct" } " for details. For passing arrays to and from C, use the " { $link "specialized-arrays" } " vocabulary." ;
 119
 120 HELP: malloc-string
 121 { $values { "string" string } { "encoding" "an encoding descriptor" } { "alien" c-ptr } }
 122 { $description "Encodes a string together with a trailing null code point using the given encoding, and stores the resulting bytes in a freshly-allocated unmanaged memory block." }
 123 { $warning "Don't forget to deallocate the memory with a call to " { $link free } "." }
 124 { $errors "Throws an error if one of the following conditions occurs:"
 125     { $list
 126         "the string contains null code points"
 127         "the string contains characters not representable using the encoding specified"
 128         "memory allocation fails"
 129     }
 130 } ;
 131
 132 HELP: require-c-array
 133 { $values { "c-type" "a C type" } }
 134 { $description "Generates a specialized array of " { $snippet "c-type" } " using the " { $link <c-array> } " or " { $link <c-direct-array> } " vocabularies." }
 135 { $notes "This word must be called inside a compilation unit. See the " { $vocab-link "specialized-arrays" } " vocabulary for details on the underlying sequence types loaded." } ;
 136
 137 HELP: <c-direct-array>
 138 { $values { "alien" c-ptr } { "len" integer } { "c-type" "a C type" } { "array" "a specialized direct array" } }
 139 { $description "Constructs a new specialized array of length " { $snippet "len" } " and element type " { $snippet "c-type" } " over the range of memory referenced by " { $snippet "alien" } "." }
 140 { $notes "The appropriate specialized array vocabulary must be loaded; otherwise, an error will be thrown. The vocabulary can be loaded with the " { $link require-c-array } " word. See the " { $vocab-link "specialized-arrays" } " vocabulary for details on the underlying sequence type constructed." } ;
 141
 142 ARTICLE: "c-strings" "C strings"
 143 "C string types are arrays with shape " { $snippet "{ char* encoding }" } ", where " { $snippet "encoding" } " is an encoding descriptor. The type " { $link char* } " is an alias for " { $snippet "{ char* utf8 }" } ". See " { $link "encodings-descriptors" } " for information about encoding descriptors."
 144 $nl
 145 "Passing a Factor string to a C function expecting a C string allocates a " { $link byte-array } " in the Factor heap; the string is then converted to the requested format and a raw pointer is passed to the function."
 146 $nl
 147 "If the conversion fails, for example if the string contains null bytes or characters with values higher than 255, a " { $link c-string-error. } " is thrown."
 148 $nl
 149 "Care must be taken if the C function expects a " { $link char* } " with a length in bytes, rather than a null-terminated " { $link char* } "; passing the result of calling " { $link length } " on the string object will not suffice. This is because a Factor string of " { $emphasis "n" } " characters will not necessarily encode to " { $emphasis "n" } " bytes. The correct idiom for C functions which take a string with a length is to first encode the string using " { $link encode } ", and then pass the resulting byte array together with the length of this byte array."
 150 $nl
 151 "Sometimes a C function has a parameter type of " { $link void* } ", and various data types, among them strings, can be passed in. In this case, strings are not automatically converted to aliens, and instead you must call one of these words:"
 152 { $subsections
 153     string>alien
 154     malloc-string
 155 }
 156 "The first allocates " { $link byte-array } "s, and the latter allocates manually-managed memory which is not moved by the garbage collector and has to be explicitly freed by calling " { $link free } ". See " { $link "byte-arrays-gc" } " for a discussion of the two approaches."
 157 $nl
 158 "A word to read strings from arbitrary addresses:"
 159 { $subsections alien>string }
 160 "For example, if a C function returns a " { $link char* } " but stipulates that the caller must deallocate the memory afterward, you must define the function as returning " { $link void* } ", and call one of the above words before passing the pointer to " { $link free } "." ;
 161