SWIG — cоздание мультиязыковых интерфейсов для C/C++ библиотек

SWIG
cоздание мультиязыковых интерфейсов
для C/C++ библиотек

Why
High level (Python, Ruby, Java, C#, Go, … )
● Высокая скорость разработки (программы для людей)
o Быстрое создание прототипов
o Рефакторинг
o Легче делать UI, сетевое взаимодействие и т.п
o REPL
● Легко кастомизируется, конфигурируется и перенастраивается
Low level (С, С++ ?)
● Высокая скорость исполнения (программы для компьютеров)
● Доступ к системным компонентам (OpenGL, DirectX и т.п)
● Портируемость на уровне исходных кодов
● Огромное количество существующего и создаваемого кода (даже на чистом C)
o libgit (C89)
o libvirt
o systemd
o CPython!
● Debug cycle (compile, run, attach, debug …)

Survey
Extending and Embedding
Dynamic and Static
Python -- библиотека для компиляции и интерпретации
байт-кода написанная на C
Явный поиск и загрузка dll, so. Интроспекция бинарных объектов.

Survey
● Python C API
● Ctypes
● Boost.Python
● Cython (pyrex)
● RPython
● SWIG
● Shiboken (PySide)
● SIP (PyQt)

Python C API (пример)
Враппер над двумя функциями
char *readline(const char *);int
add_history(const char *);

#include <Python.h>#include <readline/readline.h>
PyObject *
fn_readline(PyObject *self, PyObject *args){
char *prompt;
char *line;
PyObject *o;
if (!PyArg_ParseTuple(args, “s”, &prompt))
return NULL;
line = readline(prompt);
o = Py_BuildValue(“s”, line);
free(line);
return o;}

PyObject *
fn_add_history(PyObject *self, PyObject *args){
char *line;
int status;
PyObject *o;
if (!PyArg_ParseTuple(args, "s", &line))
return NULL;
status = add_history(line);
o = Py_BuildValue("i", status);
return o;}

Py_INCREF(Py_None); return Py_None;

static PyMethodDef
methods[] = {
{"readline", fn_readline, METH_VARARGS, NULL},
{"add_history", fn_add_history, METH_VARARGS, NULL},
{NULL, NULL, 0, NULL}};
PyMODINIT_FUNC
initreadline(void){
(void) Py_InitModule("readline", methods);}

PyMODINIT_FUNC PyInit_spam(void)
{
return PyModule_Create(&spammodule);
}
PyMODINIT_FUNC initspam(void)
{
(void) Py_InitModule("spam", SpamMethods);
}

Python C API (use)
gcc -dynamiclib -I/usr/include/python2.5 -lpython -lreadline mod_readline.c
-o readline.so
Use setup.py instead

Python C API (conclusion)
● Самая тесная интеграция с Python из всех
возможных
● Лучшая производительность
● Нужно все время считать ссылки
● Нужно хорошо знать C

Python C API (conclusion)
● Несложный в понимании и изучении для
людей с C-background
● Хорошо документирован
● Объемный
● Опасно использовать не понимая
● Что если функций не 2 а 200?

Survey
● Python C API
● Ctypes
● Boost.Python
● Cython (pyrex)
● RPython
● SWIG

Boost.Python (keynotes)
● Позволяет небольшими усилиями экспортировать
типы из C++ в Python
● Без сторонних утилит, только С++ компилятор
● None intrusive wrapping (подходит для оборачивания
сторонних библиотек без изменения их кода)
● Extensions and embedding

Boost.Python (keynotes)
● Надежная устоявшаяся библиотека (в
boost фигню не берут)
● Обновляется не часто (последний коммит
осень 2013, минорная поддержка)
● Python 3 есть
● Много successful stories...

Boost.Python (projects)
Их много, например …
● Civilization IV
● OpenSceneGraph Bindings
● PythonMagick
● Fusion (часть Twisted)

Boost.Python (code)
char const* greet(){
return "hello, world";}
>>> import hello_ext>>>
print hello_ext.greet()
hello, world
#include <boost/python.hpp>
BOOST_PYTHON_MODULE(hello_ext){
using namespace boost::python;
def("greet", greet);}

Boost.Python (code)
class_<World>("World", init<std::string>())
.def(init<double, double>())
.def("greet", &World::greet)
.def("set", &World::set);
struct World{
World(std::string msg): msg(msg) {} // added constructor
void set(std::string msg) { this->msg = msg; }
std::string greet() { return msg; }
std::string msg;};

Boost.Python (features)
● Constructors
● Class Properties
● Inheritance
● Class Virtual Functions
● Virtual Functions with Default
Implementations

Boost.Python (features, version 2)
● References and Pointers
● Globally Registered Type Coercions
● Automatic Cross-Module Type Conversions
● Efficient Function Overloading
● C++ to Python Exception Translation
● Default Arguments
● Keyword Arguments
● Manipulating Python objects in C++
● Exporting C++ Iterators as Python Iterators
● Documentation Strings

Boost.Python (C++)
● Это modern С++, детка
● Потенциально медленная
компиляция
● Потонциально сложный для
отладки и анализа код
● Ошибки инстанцирования
шаблонов
● Не header-only библиотека

Boost.Python (conclusion)
Отличная библиотека, если не боитесь C++

RPython
● Язык реализации PyPy
● Restricted Python
o Возможность статического вывода типов
o Types are inferred, not stated explicitly
o All that analysis happens on a whole-program basis!
● Трансформируется в C => компилируется
● RPython is not Python

SWIG
● User story -- мультиплатформенная бизнес логика
● Simplified Wrapper and Interface Generator
● Проект развивался с 1995
● Зародился в университетских кругах
● Постоянно обновлятся, версии выходят часто
(последняя 2014.05.27)
● GPL license -- на SWIG, что хотите -- на
сгенерированный код

SWIG (langs)
Allegro CL
C#
CFFI
CLISP
Chicken
D
Go
Guile
Java
Javascript
UFFI
Lua
Modula-3
Mzscheme
OCAML
Octave
Perl
PHP
Python
R
Ruby
Tcl

SWIG (projects)
● Subversion
● PyOgre
● PyOpenGL
● wxPython
● XML::Xerces
● OpenCV
● Crystal Space 3D
● … (много других)

example.c
example.h
example_wrap.c
example.py
example.i
SWIG

example.c
example.h
example_wrap.c
example.py
example.i python setup.by build
_example.so (pyd)

example.c
example.h
example_wrap.c
example.py
example.i pip install -e .
_example.so (pyd)
module example

SWIG (example)
/* File : example.c *//* A global variable */double Foo = 3.0;/* Compute
the greatest common divisor of positive integers */int gcd(int x, int y) {
int g;
g = y;
while (x > 0) {
g = x;
x = y % x;
y = g;
}
return g;}

SWIG (example)
/* File : example.i */%module example%inline %{
extern int gcd(int x, int y);
extern double Foo;%}

SWIG (example)
example_wrap.c
около 4000 строк кода

#ifdef __cplusplus
extern "C" {#endif
SWIGINTERN PyObject *_wrap_gcd(PyObject *SWIGUNUSEDPARM(self), PyObject *args) {
PyObject *resultobj = 0;
int arg1 ;
int arg2 ;
int val1 ;
int ecode1 = 0 ;
int val2 ;
int ecode2 = 0 ;
PyObject * obj0 = 0 ;
int result;
if (!PyArg_ParseTuple(args,(char *)"OO:gcd",&obj0,&obj1)) SWIG_fail;
ecode1 = SWIG_AsVal_int(obj0, &val1);
if (!SWIG_IsOK(ecode1)) {
SWIG_exception_fail(SWIG_ArgError(ecode1), "in method '" "gcd" "', argument " "1"" of type '" "int""'");
}
arg1 = static_cast< int >(val1);
SWIG_exception_fail(SWIG_ArgError(ecode2), "in method '" "gcd" "', argument " "2"" of type '" "int""'");
}
result = (int)gcd(arg1,arg2);
resultobj = SWIG_From_int(static_cast< int >(result));
return resultobj;
fail:
return NULL;}

#ifdef __cplusplus
extern "C" {#endif
SWIGINTERN PyObject *_wrap_gcd(PyObject *SWIGUNUSEDPARM(self),
PyObject *args) {
PyObject *resultobj = 0;
int arg1 ;
int arg2 ;
int val1 ;
int ecode1 = 0 ;
int val2 ;
int ecode2 = 0 ;
int result;
...}

if (!PyArg_ParseTuple(args,(char *)"OO:gcd",&obj0,&obj1)) SWIG_fail;
SWIG_exception_fail(SWIG_ArgError(ecode1), "in method '" "gcd" "',
argument " "1"" of type '" "int""'");
}

result = (int)gcd(arg1,arg2);
resultobj = SWIG_From_int(static_cast< int >(result));
return resultobj;
fail:
return NULL;
}

SWIG (example)
example.py
80 строк кода

SWIG (example)
# file: runme.pyimport example # Call our gcd() function
x = 42
y = 105
g = example.gcd(x,y)print "The gcd of %d and %d is %d" % (x,y,g)#
Manipulate the Foo global variable# Output its current valueprint "Foo = ",
example.cvar.Foo# Change its value
example.cvar.Foo = 3.1415926# See if the change took effectprint "Foo = ",
example.cvar.Foo

SWIG (interface file)
● Принцип отделения от оригинального *.h файла
● C, С++ препроцессор и парсер (include по
умолчанию выключены)
● % — начало всех SWIG директив
● %{ … }% -- копируется во wrap

SWIG (cases)
● Работает очень прозрачно, без магии
● Basic Type Handling
o integers
o char -- строка
o bool -- int или bool, если есть

SWIG (cases)
● Simple pointers
o непрозрачные сущности
o храняться void* и type-tag (проверка типов на
границах)
o Разыменовать нельзя
o Получить значение можно, но это бессмысленно;
поменять значения нельзя

SWIG (cases)
● Simple pointers
disown() — снять флаг владения
acquire() — установить флаг владения
own() — проверка владения (bool)
next()
append()

SWIG (cases)
%module fileioFILE *fopen(char *, char *);int fclose(FILE *);unsigned
fread(void *ptr, unsigned size, unsigned nobj, FILE *);unsigned fwrite(void
*ptr, unsigned size, unsigned nobj, FILE *);void *malloc(int nbytes);void
free(void *);

SWIG (cases)
# Copy a file def filecopy(source,target):
f1 = fopen(source,"r")
f2 = fopen(target,"w")
buffer = malloc(8192)
nbytes = fread(buffer,8192,1,f1)
while (nbytes > 0):
fwrite(buffer,8192,1,f2)
nbytes = fread(buffer,8192,1,f1)
free(buffer)

SWIG (cases)
● Derived types, structs, and classes
Everything else is a
pointer
Даже Undefined data types
+ Proxy

SWIG (cases)
struct Vector {
double x,y,z;
}

SWIG (cases)
double Vector_x_get(struct Vector *obj) {
return obj->x;}double Vector_y_get(struct Vector *obj) {
return obj->y;}double Vector_z_get(struct Vector *obj) {
return obj->z;}void Vector_x_set(struct Vector *obj, double value) {
obj->x = value;}void Vector_y_set(struct Vector *obj, double value) {
obj->y = value;}void Vector_z_set(struct Vector *obj, double value) {
obj->z = value;}

SWIG (cases)
struct Vector *new_Vector() {
return (Vector *) calloc(1,sizeof(struct
Vector));}void delete_Vector(struct Vector *obj) {
free(obj);}

SWIG (cases)
v = new_Vector()
Vector_x_set(v,2)
Vector_y_set(v,10)
Vector_z_set(v,-5)...
delete_Vector(v)

SWIG (cases)
class Vector(_object):
__swig_setmethods__ = {}
__setattr__ = lambda self, name, value: _swig_setattr(self, Vector, name, value)
__swig_getmethods__ = {}
__getattr__ = lambda self, name: _swig_getattr(self, Vector, name)
__repr__ = _swig_repr
__swig_setmethods__["x"] = _example.Vector_x_set
__swig_getmethods__["x"] = _example.Vector_x_get
if _newclass:x = _swig_property(_example.Vector_x_get, _example.Vector_x_set)
__swig_setmethods__["y"] = _example.Vector_y_set
__swig_getmethods__["y"] = _example.Vector_y_get
if _newclass:y = _swig_property(_example.Vector_y_get, _example.Vector_y_set)
__swig_setmethods__["z"] = _example.Vector_z_set
__swig_getmethods__["z"] = _example.Vector_z_get
if _newclass:z = _swig_property(_example.Vector_z_get, _example.Vector_z_set)
def __init__(self):
this = _example.new_Vector() try: self.this.append(this) except: self.this = this
__swig_destroy__ = _example.delete_Vector
__del__ = lambda self : None;
Vector_swigregister = _example.Vector_swigregister
Vector_swigregister(Vector)

SWIG (cunclusion)
● Написан на C, C++
● Без зависимостей (для запуска нужен один .exe), не
нужны целевые языки
● Доступен на многих платформах
● Работает очень быстро
● Хорошая документация
● Хороший генерируемый код (можно разобраться)
● Кастомизируемый (можно модифицировать
поведение генератора)

SWIG (cunclusion)
● Много языков (интересен универсальностью)
● Очень желательно понимать C/C++
● Не навязывает мораль (разрешает отстрелить ногу)
● Но при этом кастомизируемый, гибкий
● Требует немного больше времени на изучение, чем
Boost.Python, но начать с простого легко
● Хороший и прозрачный генерируемый код

SWIG (cunclusion)
Может оказаться очень полезным
элементом архитектуры

Спасибо за внимание!
aleksei.cherkes@gmail.com
https://www.facebook.com/aleksei.cherkes

SWIG — cоздание мультиязыковых интерфейсов для C/C++ библиотек

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Viewers also liked

Viewers also liked (13)

Similar to SWIG — cоздание мультиязыковых интерфейсов для C/C++ библиотек

Similar to SWIG — cоздание мультиязыковых интерфейсов для C/C++ библиотек (20)

More from Python Meetup

More from Python Meetup (11)

SWIG — cоздание мультиязыковых интерфейсов для C/C++ библиотек