[SWIG] SWIG原理（以C#为例）

最新推荐文章于 2023-04-01 20:39:14 发布

geodoer

最新推荐文章于 2023-04-01 20:39:14 发布

阅读量1.8k

点赞数 3

分类专栏： C/C++

本文链接：https://blog.csdn.net/summer_dew/article/details/122145327

版权

C# SWIG 代码生成 C++接口动态链接库

关键词由CSDN通过智能技术生成

C/C++ 专栏收录该内容

24 篇文章 0 订阅

订阅专栏

本文将以C#为例，讲解SWIG的原理
原文链接：https://www.yuque.com/cppdev/swig/nuaxps

SWIG本质上是一个代码生成器，它帮我们生成了一个中间层，使得目标语言能够调用到C/C++的代码。
请添加图片描述

接下来，我们将自己动手编写这个中间层，看看SWIG到底为我们做了什么。

文章目录

代码框架

本文代码：https://github.com/geodoer/swig-examples/tree/main/A-HowSWIGWork

本示例代码的框架如下：

simple模块是我们写的C/C++代码
usesimple模块是C#客户端程序，需要调用我们的C/C++代码
simple_csharp是C#中间层，它的职责有两个
1. 为C#客户端提供和C++代码一样的接口（如simple.cs）
2. 通过动态链接库，调用C/C++的代码，完成整个流程（如simplePINVOKE.cs文件）
simple_wrap是C++中间层，它将C/C++包装成C#想要的样子，供C#调用

请添加图片描述

simple模块（C/C++代码）

先来看一下C/C++代码。
C/C++代码很简单，只有一个example.h文件，里面只有一个变量和一个函数。
而我们的目标就是在C#程序中，能够使用到这个全局变量和函数。

//File: example.h

/* A global variable */
SIMPLE_API extern double Foo;

/* Compute the greatest common divisor of positive integers */
SIMPLE_API extern int gcd(int x, int y);

usesimple（C#如何使用C/C++代码）

了解C/C++代码之后，我们再看看在C#中，会如何使用我们写的C++代码。

//File: Program.cs
using System;

namespace usesimple
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");

            //Program.cs
            //调用C/C++的gcd()函数
            int x = 42;
            int y = 105;
            int g = simple.gcd(x, y);
            Console.WriteLine("The gcd of " + x + " and " + y + " is " + g);

            //操纵C/C++的Foo全局变量
            Console.WriteLine("Foo = " + simple.Foo);	//输出当前值
            simple.Foo = 3.1415926;						//改变值
            Console.WriteLine("Foo = " + simple.Foo);	//看看改变是否生效

            Console.ReadLine();
        }
    }
}

中间层

simple_csharp/simple.cs（提供给C#的接口文件）

在上一节中，我们明白了C#要如何使用C/C++的代码。
因此，我们很清楚的知道，我们需要提供给C#怎么样的接口。

//File: simple.cs
/* 提供给C#客户端调用的接口 */
public class simple
{
    public static double Foo
    {
        set
        {
            //TODO：将value设置给example.h中的Foo变量
        }
        get
        {
            //TODO：获取example.h中Foo的值
        }
    }

    public static int gcd(int x, int y)
    {
        //TODO：调用example.h中的gcd函数
    }
}

simple_wrap模块（将C/C++代码进行包装）

根据simple.cs文件，我们知道了要如何包装我们的C++代码了。
simple_wrap即是一个中间层，它将simple模块的C/C++代码，组织成C#需要的样子

//File:example_wrap.cpp
__declspec(dllexport) void __stdcall CSharp_Foo_set(double jarg1) {
	Foo = jarg1;
}

__declspec(dllexport) double __stdcall CSharp_Foo_get() {
	return Foo;
}

__declspec(dllexport) int __stdcall CSharp_gcd(int jarg1, int jarg2) {
	return gcd(jarg1, jarg2);
}

simple_csharp/simplePINVOKE.cs（C#调用C++）

simple_csharp模块中的simplePINIVOKE.cs将通过动态链接库，调用在simple_wrap模块中已经包装好C++函数，从而将整个流程打通，实现C#调用C++的通路。

//simplePINVOKE.cs

/* C#中间层
1. 调用C++中间层的代码，完成C#与C++之间的通讯
 */
class simplePINVOKE
{
    static simplePINVOKE()
    {
    }

    /// 从DLL中导入一个外部函数
    /// 
    /// DllImport的参数说明
    /// 1. 第一个参数   simple_wrap      DLL的名称
    /// 2. 第二个参数   CSharp_Foo_set   入口点，即函数名称
    [global::System.Runtime.InteropServices.DllImport("simple_wrap", EntryPoint = "CSharp_Foo_set")]
    public static extern void Foo_set(double jarg1);

    [global::System.Runtime.InteropServices.DllImport("simple_wrap", EntryPoint = "CSharp_Foo_get")]
    public static extern double Foo_get();

    /// 对于simple_csharp模块中的函数      int CSharp_gcd(int jarg1, int jarg2)
    /// 映射到C#中，函数为签名为           int gcd(int jarg1, int jarg2)
    /// 
    /// 不难发现，这里其实做了一个映射
    /// 1. C++的int类型              => C#的int类型
    /// 2. C++的函数名称为CSharp_gcd => C#的函数名称为gcd
    /// 
    /// 
    [global::System.Runtime.InteropServices.DllImport("simple_wrap", EntryPoint = "CSharp_gcd")]
    public static extern int gcd(int jarg1, int jarg2);
}