在 Swift 中使用以函数为参数的 C 函数

Posted 2023-03-14

【中文标题】在 Swift 中使用以函数为参数的 C 函数

【英文标题】：Using C functions in Swift that take functions as arguments

【发布时间】：2016-07-12 13:00:38

【问题描述】：

我正在编写一个 C 数学库的包装器。每个函数都接受一个或两个函数作为参数。但是，这些子函数（以及父函数）的参数不是 Swifty - 因此是包装器。

我已经清理了示例代码以仅显示三个主要部分：c-library 函数，将传递给包装器的所需 Swift 函数（主体未显示，但包装 c-library 函数） ，以及所需的C函数形式。

//C library function, that calls the passed function dozens, hundreds or thousands of times, each time it changes the data provided in p, and uses the output from x
//The Swift arrays are passed as pointers, and the length of the and x array are m and n respectively
returnValue = cLibraryFunc(passedFunc, &p, &x, Int32(m), Int32(n), Int32(itmax), &opts, &info, &work, &covar, &adata)


//I would like to create a Swift function that would look like this (internals could be any myriad of things that takes inputs p and adata and returns data in x:
func desiredSwifty(p: inout [Double], x: inout [Double], m: Int, n: Int, adata: inout [Double]) 
    //very simple example
    //this example knows the length of p (so m as well)
    //and assumes that adata length is the same as the x length (n)
    //obviously, it could ifer m and n from p.count and x.count

    for i in 0..<n 
        x[i] = p[0] + p[1]*adata[i]  + p[2]*pow(adata[i], 2)
    



//And the wrapper would "convert" it -internally- into the form that the C library function requires:
func requiredC(p: UnsafeMutablePointer<Double>?, x: UnsafeMutablePointer<Double>?, m: Int32, n: Int32, adata: UnsafeMutablePointer<Void>?) 
    //same thing, but using pointers, and uglier

    //first, have to bitcast the void back to a double
    let adataDouble : UnsafeMutablePointer<Double> = unsafeBitCast(adata, to: UnsafeMutablePointer<Double>.self)

    for i in 0..<Int(n) 
        x![i] = p![0] + p![1]*adataDouble[i]  + p![2]*pow(adataDouble[i], 2)
    

加法

我应该补充一点，我可以访问 c 源代码，所以我可能会添加一些虚拟参数（可能是为了找到传递上下文的方法）。但是鉴于文档似乎表明无法使用 c 函数指针获取上下文，这可能没有用。

【问题讨论】：

可怜的人将维护该代码。 （我将此类代码称为“单向/一次性代码”。）

我已经对 C 库进行了一些测试，并且由于它有很好的文档记录并被其他人使用，我对当前版本感到安全。但是，我只打算为自己使用这个包装器。我只是想隐藏C的“丑陋”。

我没有评论内容，只是评论了编码风格。大量缩进的部分在任何 PL 中都不能被认真对待。

我很想知道如何在没有嵌套 withUnsafeMutableBufferPointers 的疯狂树的情况下使用这些指针。我发现的唯一“解决方案”是为该树编写一个包装器（这意味着它仍然存在于某处）。

【参考方案1】：

（注意：以下示例在 Xcode 8 beta 2 上使用 Swift 3。）

您的问题是关于将另一个 C 函数作为参数的 C 函数，所以让我们将问题简化为该问题。这是一个简单的 C 函数，它接受一个参数，即 又是一个 C 函数，它接受一个指向双精度数组的指针 和一个整数计数：

// cfunction.h:
void cFunc(void (*func)(double *values, int count));

// cfunction.c:
void cFunc(void (*func)(double *values, int count)) 
    double x[] =  1.2, 3.4, 5,6 ;
    func(x, 3);

这个函数被导入到 Swift 中

func cFunc(_ func: (@convention(c) (UnsafeMutablePointer<Double>?, Int32) -> Swift.Void)!)

这里 @convention(c) 声明块具有 C 风格调用 公约。特别是，在 Swift 中，您只能传递一个全局函数或一个不捕获任何上下文的闭包。

Swift 包装器的一个简单示例是

func swiftyFunc(passedFunc: (@convention(c) (UnsafeMutablePointer<Double>?, Int32) -> Void)) 
    cFunc(passedFunc) 

你可以这样使用：

func functionToPass(values: UnsafeMutablePointer<Double>?, count: Int32) 
    let bufPtr = UnsafeBufferPointer(start: values, count: Int(count))
    for elem in bufPtr  print(elem) 


swiftyFunc(passedFunc: functionToPass)

或带有闭包参数：

swiftyFunc  (values, count) in
    let bufPtr = UnsafeBufferPointer(start: values, count: Int(count))
    for elem in bufPtr  print(elem) 

【讨论】：

我正在使用 Swift 3。我正在查看您的答案（就在我以为我已经弄清楚之后），但是编译器错误和您的答案都导致我遇到了同样的问题。如果我无法捕捉上下文，那我该如何工作。您的示例与我（认为我）需要的包装完全相反。我认为我需要一个包装 swiftyFunc 的 cFunc（而 swiftyFunc 是作为参数传递的）

（网络问题）。我认为我需要一个 cFunc 来包装传入主包装器的 swiftyFunc。然后那个 cFunc 就是传递给我要包装的 c 库函数的内容。

我从你的问题中取了名字。 swiftyFunc 是包装器。它将 Swift 函数 functionToPass 传递给 cFunc，后者又用一些数据调用 functionToPass。也许我误解了这个问题？ – 您不能将带有捕获上下文的闭包传递给需要函数参数的 C 函数。唯一的方法是以void *userData 指针的形式传递上下文，例如***.com/questions/30786883/…。

您使用了相同的名称。但是，我制作 swift 包装器的目的是避免将指针类型用作函数参数。我希望传递给包装器的 Swift 函数使用我在包装器函数声明中显示的“干净”参数。而且我希望能够将传递函数的任何内容“破坏”/“转换”/任何传递到我使用可变指针显示的格式。这样，所有的转换都发生在我正在构建的框架内，没有任何“讨厌”的参数暴露给我的消费者代码。

@AdamJones：这应该是可能的，但必须将数据从 C 数组复制 到 Swift 数组并返回。 – C 函数是否分配数组？回调是只读取内容还是修改内容？

【参考方案2】：

您知道只需使用& 运算符就可以获得指向var 的可变指针吗？它也在数组上做“正确的事情”。

func foo(_ x: UnsafeMutablePointer<Int>) 
    print(x)


func bar(_ x: UnsafeMutablePointer<Int>) 
    print(x)


var array = [0]
foo(&array)

var int = 0
bar(&int)

（在 Swift 2 上测试，但很可能在 Swift 3 上仍然有效。）

我怀疑这会大大减少您对包装器的需求。

【讨论】：

我知道（这是许多语言的标准功能）。我看不出它在这里有什么帮助。

这就是我为 inout 参数传递所有数组的方式。

这不是你的问题所显示的，至少。超过一半的 swiftyFunc 行是对withUnsafeMutableBufferPointer 的调用。你可以指责我草率下结论，但这确实掩盖了你想要做什么。

一旦有时间，我决定回去查看文档、Swift 定义以及网络上的大量文档。我的代码中还有一些其他大型数组不断附加，并且我编写了相当多的代码来对它们的操作进行排队。因此，当我为 Accelerate 函数编写一些包装器时，我想确保指针在调用期间保持有效，而 withUnsafeBufferPointer 是我遇到的（我看到其他包装器库也做同样的事情）。但是，是的，它只使用 & 符号编译。

我猜在值类型数组的情况下，Apple 文档对幕后发生的事情非常模棱两可。他们建议使用 Array 或 ContiguousArray，withUnsafeMutableBufferPointer 表示它确保指向一块连续的内存。但是，关于& 的使用没有任何说明。也许我的代码被过度保护了，但我在文档中找不到任何保证它不是。这里的任何指针（双关语）都会有所帮助。