将OpenCV的代码从C++移植到C语言过程小记

1、需求背景

最近有个项目要求将OpenCV的一个函数移植成由C语言编写，虽然我很不想干这件事情，但是毕竟是工作，还是得干。

本篇文章分享一下将C++代码移植成C语言的基本思路，和过程中遇到的问题。

2、移植成C语言

2.0 移除namespace特性

这个很简单，直接删。

2.1 移除template特性

C++的模板编程可以将多种类型的输入编译成分别对应的函数。

在C语言中，模板编程往往只会被解释成其中的一种。当然，如果被解释成多种，那就创建同样数量的类或函数就可以了。不同的类或函数可以增加不同的后缀以区分，例如 Point2f 表示 float 类型、Point2i 表示 int 类型。

C++代码：

template<typename _Tp> class Point_
{
public:
    _Tp x;
    _Tp y;

    Point_() : x(0), y(0) {}
    Point_(_Tp _x, _Tp _y) : x(_x), y(_y) {}

    Point_<_Tp> operator-(const Point_<_Tp>& other) {
        return Point_<_Tp>(x - other.x, y - other.y);
    }

    float cross(const Point_& other) const {
        return x * other.y - y * other.x;
    }
};

typedef Point_<float> Point2f;

移除模板特性：

class Point2f
{
public:
    Point2f() = default;
    Point2f(float _x, float _y) : x(_x),  y(_y) {}

    float x = 0.f;
    float y = 0.f;

    Point2f operator-(const Point2f& other) const {
        return Point2f(x - other.x, y - other.y);
    }

    float cross(const Point2f& other) const {
        return x * other.y - y * other.x;
    }
};

2.2 移除class特性

C++的class主要实现了类属性、内置方法、重载操作符，这3个特性。

类属性可以用 typedef 的结构体实现。并且这一步可以不用一步到位，可以在所有的类方法逐渐移植完毕之后，最后再做修改。

内置方法我改为同前缀的一个一个单独的函数，将自己的结构体传入又传出。

重载运算符我采用Python命名风格，例如对减号的操作符重载，实现为 Point_sub 这样的形式。

C++代码：

// 定义类属性、重载运算符、和类方法
class Point2f
{
public:
    Point2f() = default;
    Point2f(float _x, float _y) : x(_x),  y(_y) {}

    float x = 0.f;
    float y = 0.f;

    Point2f operator-(const Point2f& other) const {
        return Point2f(x - other.x, y - other.y);
    }

    float cross(const Point2f& other) const {
        return x * other.y - y * other.x;
    }
};

// 调用
Point2f p1, p2;
Point2f p3 = p2 - p1;
float result = p1.cross(p2);

移除class特性：

// 类变成结构体
typedef struct {
    float x, y;
} Point2f;

// 重载运算符变成传参函数
Point2f Point2f_sub(const Point2f& self, const Point2f& other) {
    auto x = self.x, y = self.y;
    return Point2f{x - other.x, y - other.y};
}

// 类方法变成传参函数
float Point2f_cross(const Point2f& self, const Point2f& other) {
    auto x = self.x, y = self.y;
    return x * other.y - y * other.x;
}

// 调用
Point2f p1, p2;
Point2f p3 = Point2f_sub(p2, p1);
float result = Point2f_cross(p1, p2);

2.3 移除vector特性

vector 是动态数组，必然不可能重构成支持弹性数组的结构、同时还能支持 [] 符号按下标取出元素。因为弹性数组必然导致内存重新分配，那么首地址就会改变。而C语言中 [] 符号只是地址求值的语法糖，肯定会取出错误的结果。

完全等效的做法我可以实现一个 vector 结构体，里面包含数据长度（length）和数据区（data）两个属性。在 push_back 的时候实现内存重新分配，并对 length 和 data 重新赋值。在取元素的时候从 vector->data 位置取出数据，这样就可以实现内存重新分配也不会影响数据区的取值。

但是这样过于复杂，对源代码改动量也过大（求值部分需要依次增加 ->data），我不如评估一个数组的最大长度，然后将数组首地址和数组长度的指针一起传入函数，在 vector 需要变化长度（例如 push_back）的时候，同步修改这个长度数据。

C++代码：

int foo(std::vector<Point2f> &points)
{
    if(!points.empty())
        points.resize(4);

    points.push_back(Point2f(xi, yi));
    int N = points.size();
    std::vector<float> distPt(N);
    float* pDist = distPt.data();
}

// 调用
std::vector<Point2f> points;
foo(points);
printf("Size=%d\n", points.size());

移除vector依赖：

int foo(Point2f* points, int* points_size)
{
    if (points_size[0])
        points_size[0] = 4;

    points[points_size[0]++] = Point2f(xi, yi);
    int N = points_size[0];
    float distPt[N];
    float* pDist = distPt;
}

// 调用
Point2f points[100];  // 申请足够大的空间
int points_size = 0;
foo(points, &points_size);
printf("Size=%d\n", points_size);

需要注意的是，*array_size++ 和 array_size[0]++ 的计算不等效，注意运算符的计算顺序。

另外，如果vector传入函数之后并未发生长度改变（例如没有 push_back），那么数据长度可以不用传入数字指针类型，直接传入数字本身也行。

2.4 移除std函数

需要注意 std::abs 对应的不是 abs 函数，而是 fabs，否则返回值会成为整数。max 和 min 同理。

C++	C
#include <iostream>	#include <stdio.h>
std::cout << "Name: " << name << std::endl;	printf(“Name: %s\n”, name);
std::cout << "Age: " << age << std::endl;	printf(“Age: %d\n”, age);
#include <algorithm>	#include <math.h>
std::abs	fabs
std::min	fmin
std::max	fmax
std::ininf	ininf
std::isnan	isnan
std::swap	TYPE temp = a; a = b; b = temp;

2.5 移除引用传值

C++为了减少拷贝、和提高语法的可读性，引入了 &parameter 这样的引用传参形式。

在C语言中和传入 &parameter 完全等效的写法，是传入指针，然后在函数内求地址。

但是如果传入的是 const &parameter 类型，说明 &parameter 在函数内没有被更改过，所以直接把 & 去掉就可以了（也许C++这么写的考虑是减少内存拷贝次数？我不太清楚）。

2.6 移除auto类型推导

C语言中的 auto 关键字表示的实际上是 int，需要将C++中所有出现 auto 的地方替换为真正需要的类型。

至于怎么类型推导，那当然是人肉推导啦（笑）。

2.7 C++中的关键词

C++中比C语言多几个关键词，可以用宏定义来替代：

#define bool char
#define true 1
#define false 0
#define nullptr 0

2.8 其他语言差异

C++代码：

return Point2f(x, y);

移植为C语言：

Point2f result = {x, y};
return result;  // 无法直接赋值返回

3、测试和杂项

3.1 C语言和C++编译兼容

要在C++中调用C语言编译文件中的程序，需要在头文件中增加一段：

#ifdef __cplusplus
extern "C" {
#endif

// 函数原型定义
int foo(int arg1, float arg2, char* arg3);

#ifdef __cplusplus
}
#endif

3.2 GCC用C语言规则编译源文件

使用 -x 参数可以指定按照特定语言规则编译某种文件，多次指定 -x 参数后则可混合规则编译：

g++ -xc source.cpp -xc++ test.cpp -o test.exe

此命令可将 source.cpp 文件依照C语言规则编译，test.cpp 依照C++规则编译，最后通过C++规则进行链接，生成为 test.exe 文件。

3.3 修改文件名后缀

将 .cpp 后缀的文件修改为 .c 后缀即可，可避免某些编译器只能通过文件名后缀识别代码语言。

4、最终代码

最终结果用约400行C语言代码完成。

代码仓库可见GitHub：

https://github.com/znsoooo/opencv-calc-rotated-iou

分步修改步骤可见提交记录：

https://github.com/znsoooo/opencv-calc-rotated-iou/commits/master