OCaml ctypes处理参数的惯用方法

Gre*_*bet 13 ocaml

我正在为一些使用out-parameter idiom并返回错误代码的C函数编写OCaml包装器.我一直在使用OCaml端分配C数组来包装它们Ctypes.allocate_n.然后将内容复制到OCaml类型中.

我觉得我正在解决一个问题,Ctypes或者其他一些模块已经以另一种方式解决了,这是一个例子.

gethostname(2) 有以下类型:

int gethostname(char *name, size_t len);
Run Code Online (Sandbox Code Playgroud)

这是out_parameter.mli包装gethostname功能.

val gethostname : int -> [> `Ok of string | `Error of int];;
Run Code Online (Sandbox Code Playgroud)

这是实施

open Core.Std;;
let (@->) = Ctypes.(@->);;
let returning = Ctypes.returning;;
open Foreign;;

let gethostname size =
  let size' = Unsigned.Size_t.of_int size in
  let c_gethostname =
    foreign "gethostname" (Ctypes.ptr Ctypes.char @-> Ctypes.size_t @-> returning Ctypes.int) in
  let buf = Ctypes.allocate_n Ctypes.char ~count:size in
  let err = c_gethostname buf size' in
  match err with
  | 0 -> (
    `Ok (Ctypes.string_from_ptr buf ~length:size)
    )
  | _ -> `Error err;;

let main () =
  Printf.printf "%s\n" (match gethostname 1000 with
  | `Ok hostname -> hostname
  | `Error _ -> "error getting hostname");;

let () = main ();;
Run Code Online (Sandbox Code Playgroud)

为了充实,我out_parameter.native用这个命令编译.

$ corebuild -pkg ctypes.foreign out_parameter.native
Run Code Online (Sandbox Code Playgroud)

代码确实有效并返回主机名,并删除尾随的空字节.

$ ./out_parameter.native
MY-HOSTNAME

$ ./out_parameter.native | sed -e 's/\x0/@/g'
MY-HOSTNAME
Run Code Online (Sandbox Code Playgroud)

Éti*_*lon 6

看起来你的代码是有效的并且是惯用的.有两种表示错误的方法:

  • 你可以抛出一个例外.
  • 您可以使用结果类型.如果你这样做,我建议使用"new"内置result类型(在结果包中已经为旧版本的OCaml反向移植).

一般来说,您负责编写支持该错误约定match err的代码(代码中的部分).通常可以编写几个组合器来减少样板.

但是,ctypes如果您使用Cstubs(代码生成),则会提供一些快捷方式:

  • errno_policy可以实现libc的errno约定.
  • concurrency_policy可以调整C代码,使其对应于给定的并发模型(lwt等).这不是关于错误约定,而是有些相关.

如果你坚持Foreign(这使你的构建系统比简化Cstubs),那么我建议你手工完成它,或者如果你有很多类似的功能就提取几个组合器.