package lintcstubs-arity

You can search for identifiers within the package.

in-package search v0.2.0

Generate headers for C bindings

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

E

Edwin Török <edwin.torok@cloud.com>

Maintainers

E

Edwin Török <edwin.torok@cloud.com>

Sources

lintcstubs-arity-0.2.2.tbz

sha256=8404776464f04fa0fd324c0b5f7ec1529438d3097c867882319b7076d609288e

sha512=b80dcd892a7e9d068c8980d361e86a55c061e3b4b2504b85239df43fcaea60163144afdf42c92c4a76fee773e0431a86e5fa51be3478e3549f8b31dee1ccd540

doc/lintcstubs-arity.primitives_of_cmt/Primitives_of_cmt/index.html

Module `Primitives_of_cmt`Source

Typedtree has an unstable API (depends on compiler version), so extract the parts we need and convert to types defined in this file. If the build breaks with new compiler versions then only this module needs to be updated (perhaps by using Dune's support to conditionally select files based on compiler versions)

Sourcetype native_arg =

| Value
| Double
| Int32
| Int64
| Intnat of {
1. untagged_int : bool;
}
| Bytecode_argv
| Bytecode_argn

Sourceval ctype_of_native_arg : native_arg -> string

ctype_of_native_arg arg returns the C type used when implementing primitives for native code mode.

see https://v2.ocaml.org/manual/intfc.html#ss:c-unboxed
on the use of intnat

Sourcetype t = {

byte_name : string;
(*
name of C function implementing the primitive in bytecode mode
*)
native_name : string;
(*
name of C function implementinmg the primitive in native code mode
*)
arity : int;
(*
number of arguments to C function in native code mode
*)
alloc : bool;
(*
whether it allocates/raises exceptions
*)
native_result : native_arg;
(*
result type of the C function implementing the primitive in native code mode
*)
native_args : native_arg list;
(*
type of the arguments of the C function implementing the primitive in native code mode
*)

}

Sourceval iter_primitives_exn : path:string -> (Types.type_expr -> t -> unit) -> unit

iter_primitives_exn ~path primitive_description will load the .cmt/.cmti file path and iterate on any primitives defined using primitive_description.

Exceptions from compiler-libs may escape, so it is recommended to wrap calls using with_report_exceptions.

Sourceval with_report_exceptions : (unit -> 'a) -> 'a

with_report_exceptions f will report any compiler-libs exceptions escaping from f and exit the process with code 2.