ag/cpython-source-deps
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix formatting of ffi_prep_closure_loc arguments

Browse Source
This commit is contained in:
Tom Tromey
2015-12-17 16:51:32 -07:00
parent 88deacdd42
commit 8a7cdeb041
1 changed files with 20 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
doc/libffi.texi
View File

@@ -776,23 +776,30 @@ the closure function:
@findex ffi_prep_closure_loc @findex ffi_prep_closure_loc
@defun ffi_status ffi_prep_closure_loc (ffi_closure *@var{closure}, ffi_cif *@var{cif}, void (*@var{fun}) (ffi_cif *@var{cif}, void *@var{ret}, void **@var{args}, void *@var{user_data}), void *@var{user_data}, void *@var{codeloc}) @defun ffi_status ffi_prep_closure_loc (ffi_closure *@var{closure}, ffi_cif *@var{cif}, void (*@var{fun}) (ffi_cif *@var{cif}, void *@var{ret}, void **@var{args}, void *@var{user_data}), void *@var{user_data}, void *@var{codeloc})
Prepare a closure function. Prepare a closure function. The arguments to
@code{ffi_prep_closure_loc} are:
@var{closure} is the address of a @code{ffi_closure} object; this is @table @var
the writable address returned by @code{ffi_closure_alloc}. @item closure
The address of a @code{ffi_closure} object; this is the writable
address returned by @code{ffi_closure_alloc}.
@var{cif} is the @code{ffi_cif} describing the function parameters. @item cif
Note that this object, and the types to which it refers, must be kept The @code{ffi_cif} describing the function parameters. Note that this
alive until the closure itself is freed. object, and the types to which it refers, must be kept alive until the
closure itself is freed.
@var{user_data} is an arbitrary datum that is passed, uninterpreted, @item user_data
to your closure function. An arbitrary datum that is passed, uninterpreted, to your closure
function.
@var{codeloc} is the executable address returned by @item codeloc
@code{ffi_closure_alloc}. The executable address returned by @code{ffi_closure_alloc}.
@item fun
The function which will be called when the closure is invoked. It is
called with the arguments:
@var{fun} is the function which will be called when the closure is
invoked. It is called with the arguments:
@table @var @table @var
@item cif @item cif
The @code{ffi_cif} passed to @code{ffi_prep_closure_loc}. The @code{ffi_cif} passed to @code{ffi_prep_closure_loc}.
@@ -814,6 +821,7 @@ A vector of pointers to memory holding the arguments to the function.
The same @var{user_data} that was passed to The same @var{user_data} that was passed to
@code{ffi_prep_closure_loc}. @code{ffi_prep_closure_loc}.
@end table @end table
@end table
@code{ffi_prep_closure_loc} will return @code{FFI_OK} if everything @code{ffi_prep_closure_loc} will return @code{FFI_OK} if everything
went ok, and one of the other @code{ffi_status} values on error. went ok, and one of the other @code{ffi_status} values on error.