# C++与Python的混合编译

我们来尝试编译一个helloworld

// main.cpp

#include<iostream>
using namespace std;
int main(){
    cout<<"c++ is best language"<<endl;
    return 0
}
1
2
3
4
5
6
7
8

编译的顺序是怎样的呢?

workflow

gcc --h显示的编译命令如下:

-B <directory>           Add <directory> to the compiler's search paths
#添加编译器的搜索路径(例如头文件等)
-v                       Display the programs invoked by the compiler
#显示被编译器调用的程序
-###                     Like -v but options quoted and commands not executed
-E                       Preprocess only; do not compile, assemble or link
#只预处理不编译汇编或者链接
-S                       Compile only; do not assemble or link
#只编译不汇编和链接
-c                       Compile and assemble, but do not link
#编译和汇编,不连接
-o <file>                Place the output into <file>
#输出到文件
-pie                     Create a position independent executable
#创建与位置无关的可执行文件
-shared                  Create a shared library
#创建一个共享库
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

对于这样一个非常基础的没有额外依赖的cpp文件来说,编译过程当然也相当简单:

g++ -c main.cpp
#只编译和汇编main.cpp不链接生成main.o的目标代码文件
1
2

如果我们还想执行这个代码就要生成可执行文件

g++ -o main.out main.o
#输出到.out可执行文件

#也可以合并执行
g++ -o hello.out hello.cpp
#直接编译并输出到可执行文件
1
2
3
4
5
6

则./xx.out 就可以运行编译完成的可执行文件了。但是这个并不是典型的应用场景。我们用下面的三个代码来模拟日常更常用的C++工作模式

// human.h

#ifndef HEAD_H
#define HEAD_H
#include <iostream>
using namespace std;
class Human
{
private:
    /* data */
public:
void Say();
void SaywithPython();
};
#endif
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// human.cpp

#include "human.h"

void Human::Say(){
    cout<<"Im Human, c++ is worst"<<endl;
}
void Human::SaywithPython(){
    cout<<"Python is best language"<<endl;
}
1
2
3
4
5
6
7
8
9
10
//main.cpp
#include <iostream>
#include "head.h"
using namespace std;

int main(){
    cout <<"C++ is best language"<<endl;
    Human Jarvis;
    Jarvis.Say();
    return 0;
}
1
2
3
4
5
6
7
8
9
10
11

这一小段程序包含了非常多的技巧。首先定义了head以及function本地头文件和实现,在cpp文件中实现了两个公开的方法,又在main中调用了实例化对象中的该方法。

由于涉及了多个文件因此我们必须有一种方法来指定编译器的行为——MakeFile

human.o : human.h human.cpp
	g++ -g -c human.cpp
main.o : main.cpp human.h
	g++ -g -c main.cpp
build : main.o human.o
	g++ -o build main.o human.o
clean :
	rm human.o main.o
#pylib : function.cpp
#   g++ -o pylib.so -shared -fPIC function.cpp
1
2
3
4
5
6
7
8
9
10

其中语法为:

target ... : prerequisites ...
  command    #tab
1
2
  • target为目标文件
  • prerequisites为生成目标文件所需的文件
  • command为编译该目标文件所需的指令

所以目前我们可以按照之前的C++编译流程图,整理出的依赖顺序为:

  1. 编译human.cpp 依赖于hunman.h 生成human.o 即:
human.o : human.h human.cpp
    g++ -g -c human.cpp

1
2
3
  1. 编译main.cpp依赖于head.h 生成 main.o 即:
main.o : main.cpp human.h
    g++ -g -c main.cpp

1
2
3
  1. 编译可执行文件依赖于main.o human.o 生成指定的可执行文件(build)即:
build : main.o human.o
    g++ -o build main.o human.o
1
2

具体在执行过程中则遵循依赖,书写则从可执行文件开始(如果确实要生成可执行文件的话)

至此命令行中输入make进行编译,结果等同于:

g++ -g -c main.cpp
g++ -g -c human.cpp
g++ -o build main.o human.o
1
2
3

生成了build可执行文件 结果:

c++ is best language

Im Human, c++ is worst
1
2
3

通过这一步我们解决了C++编译的问题,那我们怎么解决Python和C++的混编呢?

重新编写

// human.cpp

#include "human.h"

void Human::Say(){
    cout<<"Im Human ,You are shit"<<endl;
}
void Human::SaywithPython(){
    cout<<"Python is best language"<<endl;

}

extern "C"{
    Human pythonman;
    void SaywithPython(){
        pythonman.SaywithPython();
        cout<<"C++ IS SHIT!!"<<endl;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

通常来说,在模块的头文件中对本模块提供给其他模块引用的函数和全局变量以关键字extern声明。

Tips:

  • extern是C/C++语言中表明函数和全局变量的作用范围的关键字,该关键字告诉编译器,其申明的函数和变量可以在本模块或其他模块中使用。
  • 被extern "C"修饰的变量和函数是按照C语言方式进行编译和链接的
  • extern int a; 仅仅是一个变量的声明,其并不是在定义变量a,并未为a分配空间。变量a在所有模块中作为一种全局变量只能被定义一次,否则会出错。
  • extern对应的关键字是static,static表明变量或者函数只能在本模块中使用,因此,被static修饰的变量或者函数不可能被extern C修饰。 这一步的目的是通过MakeFile生成动态链接库,在Unix like系统中一般为.so文件:
human.o : human.h human.cpp
	g++ -g -c human.cpp
main.o : main.cpp human.h
	g++ -g -c main.cpp
build : main.o human.o
	g++ -o build main.o human.o
clean :
	rm human.o main.o

pylib : human.cpp
    g++ -o pylib.so -shared -fPIC function.cpp
#通过 -shared 生成 .so文件
1
2
3
4
5
6
7
8
9
10
11
12

通过

make pylib
1

就可以生成pylib.so文件 此时我们开始建立python脚本

// main.py

import ctypes
ll=ctypes.cdll.LoadLibrary
#载入动态链接库
lib=ll('/path/pylib.so')
#ll('动态链接库文件的路径')
lib.SaywithPython()
1
2
3
4
5
6
7
8

输出:

Python is best language
C++ IS SHIT!!
1
2

至此 我们完成了Python调用C++的实践