如何为返回完整结构的C函数编写Raku声明？

Question

我有这个C代码：

typedef struct {
  double dat[2];
} gsl_complex;

gsl_complex gsl_poly_complex_eval(const double c[], const int len, const gsl_complex z);

C函数返回整个结构，而不仅仅是指针，因此我不能将Raku声明写为：

sub gsl_poly_complex_eval(CArray[num64] $c, int32 $len, gsl_complex $z --> gsl_complex)
  is native(LIB) is export { * }

有什么建议吗？

Answer 1

为此，您需要一个CStruct。该P5localtime模块包含一个更复杂的例子。

Answer 2

问题

一些 C API 使用三阶段方法处理结构，通过引用传递结构，如下所示：

struct mystruct *init_mystruct(arguments, ...);
double compute(struct mystruct *);
void clean_mystruct(struct mystruct *);

通过这种方式，实现隐藏了数据结构，但是这是有代价的：最终用户必须跟踪他们的指针并记得自己清理，否则程序将泄漏内存。
另一种方法是我所连接的库使用的方法：返回堆栈上的数据，因此可以将其分配给变量auto，并在超出范围时自动丢弃。
在本例中，API 被建模为两阶段操作：

struct mystruct init_mystruct(arguments, ...);
double compute(struct mystruct);

该结构按值在堆栈上传递，之后无需清理。
但 Raku 的 NativeCall 接口只能使用通过引用传递它们的 C 结构，因此出现了问题。

解决方案

这不是一个干净的解决方案，因为它又回到了所描述的第一种方法，即三相方法，但这是迄今为止我能够设计的唯一方法。
在这里，我考虑了库 API 中的两个 C 函数：第一个将复数创建为结构体，第二个将两个数字相加。
首先，我编写了一个微小的 C 代码接口，文件complex.c：

#include <gsl/gsl_complex.h>
#include <gsl/gsl_complex_math.h>
#include <stdlib.h>

gsl_complex *alloc_gsl_complex(void)
{
  gsl_complex *c = malloc(sizeof(gsl_complex));
  return c;
}

void free_gsl_complex(gsl_complex *c)
{
  free(c);
}

void mgsl_complex_rect(double x, double y, gsl_complex *res)
{
  gsl_complex ret = gsl_complex_rect(x, y);
  *res = ret;
}

void mgsl_complex_add(gsl_complex *a, gsl_complex *b, gsl_complex *res)
{
  *res = gsl_complex_add(*a, *b);
}

我这样编译它：
gcc -c -fPIC complex.c
gcc -shared -o libcomplex.so complex.o -lgsl
注意最后-lgsl用于链接我正在连接的 libgsl C 库。
然后我编写了Raku底层接口：

#!/usr/bin/env raku

use NativeCall;

constant LIB  = ('/mydir/libcomplex.so');

class gsl_complex is repr('CStruct') {
  HAS num64 @.dat[2] is CArray;
}

sub mgsl_complex_rect(num64 $x, num64 $y, gsl_complex $c) is native(LIB) { * }
sub mgsl_complex_add(gsl_complex $a, gsl_complex $b, gsl_complex $res) is native(LIB) { * }
sub alloc_gsl_complex(--> gsl_complex) is native(LIB) { * }
sub free_gsl_complex(gsl_complex $c) is native(LIB) { * }

my gsl_complex $c1 = alloc_gsl_complex;
mgsl_complex_rect(1e0, 2e0, $c1);
say "{$c1.dat[0], $c1.dat[1]}";          # output: 1 2
my gsl_complex $c2 = alloc_gsl_complex;
mgsl_complex_rect(1e0, 2e0, $c2);
say "{$c2.dat[0], $c2.dat[1]}";          # output: 1 2
my gsl_complex $res = alloc_gsl_complex;
mgsl_complex_add($c1, $c2, $res);
say "{$res.dat[0], $res.dat[1]}";        # output: 2 4
free_gsl_complex($c1);
free_gsl_complex($c2);
free_gsl_complex($res);

请注意，我必须显式释放我创建的三个数据结构，破坏了原始 C API 的精心设计。