Розробка API обгортки C для об’єктно-орієнтованого коду C ++

Question 1

Я прагну розробити набір API-інтерфейсів C, які будуть обгортати наші існуючі API-інтерфейси C ++ для доступу до нашої основної логіки (написаної на об'єктно-орієнтованій C ++). По суті, це буде API для склеювання, який дозволяє використовувати нашу логіку C ++ іншими мовами. Які хороші підручники, книги чи найкращі практики вводять поняття, що стосуються обгортання C навколо об’єктно-орієнтованого C ++?

Question 2

Це не надто складно зробити вручну, але це залежатиме від розміру вашого інтерфейсу. Випадки, коли я це робив, полягали в тому, щоб дозволити використання нашої бібліотеки C ++ із чистого коду C, і, отже, SWIG не дуже допоміг. (Ну, можливо, для цього можна використовувати SWIG, але я не гуру SWIG, і це здавалося нетривіальним)

Все, що ми в підсумку зробили, це:

Кожен об'єкт передається в C непрозорий дескриптор.
Конструктори та деструктори обертаються чистими функціями
Функції-члени - це чисті функції.
Інші вбудовані елементи, де це можливо, відображаються на еквіваленти C.

Отже, такий клас (заголовок C ++)

class MyClass
{
  public:
  explicit MyClass( std::string & s );
  ~MyClass();
  int doSomething( int j );
}

Було б відображено інтерфейс C на зразок цього (заголовок C):

struct HMyClass; // An opaque type that we'll use as a handle
typedef struct HMyClass HMyClass;
HMyClass * myStruct_create( const char * s );
void myStruct_destroy( HMyClass * v );
int myStruct_doSomething( HMyClass * v, int i );

Реалізація інтерфейсу буде виглядати так (джерело C ++)

#include "MyClass.h"

extern "C" 
{
  HMyClass * myStruct_create( const char * s )
  {
    return reinterpret_cast<HMyClass*>( new MyClass( s ) );
  }
  void myStruct_destroy( HMyClass * v )
  {
    delete reinterpret_cast<MyClass*>(v);
  }
  int myStruct_doSomething( HMyClass * v, int i )
  {
    return reinterpret_cast<MyClass*>(v)->doSomething(i);
  }
}

~~Ми отримуємо нашу непрозору ручку з оригінального класу, щоб уникнути необхідності будь-якого кастингу, та~~ (Це, здається, не працювало з моїм поточним компілятором). Ми повинні зробити дескриптор структурою, оскільки C не підтримує класи.

Отже, це дає нам основний інтерфейс C. Якщо ви хочете отримати більш повний приклад, що показує один із способів інтеграції обробки винятків, тоді ви можете спробувати мій код на github: https://gist.github.com/mikeando/5394166

Найцікавішою частиною тепер є забезпечення того, щоб ви правильно отримали всі необхідні бібліотеки C ++, пов’язані з вашою більшою бібліотекою. Для gcc (або clang) це означає просто робити фінальний етап посилання за допомогою g ++.

Question 3

Я думаю, що відповідь Майкла Андерсона на правильному шляху, але мій підхід буде іншим. Вам доведеться турбуватися про одне зайве: винятки. Винятки не є частиною C ABI, тому ви не можете дозволити, щоб винятки коли-небудь були пропущені поза кодом C ++. Отже, ваш заголовок буде виглядати так:

#ifdef __cplusplus
extern "C"
{
#endif
    void * myStruct_create( const char * s );
    void myStruct_destroy( void * v );
    int myStruct_doSomething( void * v, int i );
#ifdef __cplusplus
}
#endif

А файл .cpp вашої обгортки буде виглядати так:

void * myStruct_create( const char * s ) {
    MyStruct * ms = NULL;
    try { /* The constructor for std::string may throw */
        ms = new MyStruct(s);
    } catch (...) {}
    return static_cast<void*>( ms );
}

void myStruct_destroy( void * v ) {
    MyStruct * ms = static_cast<MyStruct*>(v);
    delete ms;
}

int myStruct_doSomething( void * v, int i ) {
    MyStruct * ms = static_cast<MyStruct*>(v);
    int ret_value = -1; /* Assuming that a negative value means error */
    try {
        ret_value = ms->doSomething(i);
    } catch (...) {}
    return ret_value;
}

Ще краще: якщо ви знаєте, що все, що вам потрібно як єдиний екземпляр MyStruct, не ризикуйте мати справу з порожніми вказівниками, що передаються у ваш API. Замість цього зробіть щось подібне:

static MyStruct * _ms = NULL;

int myStruct_create( const char * s ) {
    int ret_value = -1; /* error */
    try { /* The constructor for std::string may throw */
        _ms = new MyStruct(s);
        ret_value = 0; /* success */
    } catch (...) {}
    return ret_value;
}

void myStruct_destroy() {
    if (_ms != NULL) {
        delete _ms;
    }
}

int myStruct_doSomething( int i ) {
    int ret_value = -1; /* Assuming that a negative value means error */
    if (_ms != NULL) {
        try {
            ret_value = _ms->doSomething(i);
        } catch (...) {}
    }
    return ret_value;
}

Цей API набагато безпечніший.

Але, як згадував Майкл, зв’язування може стати досить складним.

Сподіваюся, це допомагає

Question 4

Неважко виставити код C ++ на C, просто використовуйте шаблон дизайну Facade

Я припускаю, що ваш код C ++ вбудований у бібліотеку, все, що вам потрібно зробити, - це зробити один модуль C у вашій бібліотеці C ++ як фасад для вашої бібліотеки разом із чистим заголовком C. Модуль C викличе відповідні функції C ++

Щойно ви це зробите, ваші програми та бібліотека C матимуть повний доступ до C api, який ви відкрили.

наприклад, ось зразок модуля Facade

#include <libInterface.h>
#include <objectedOrientedCppStuff.h>

int doObjectOrientedStuff(int *arg1, int arg2, char *arg3) {
      Object obj = ObjectFactory->makeCppObj(arg3); // doing object oriented stuff here
      obj->doStuff(arg2);
      return obj->doMoreStuff(arg1);
   }

потім ви виставляєте цю функцію C як свій API, і ви можете вільно використовувати її як бібліотеку C, не турбуючись

// file name "libIntrface.h"
extern int doObjectOrientedStuff(int *, int, char*);

Очевидно, що це надуманий приклад, але це найпростіший спосіб розкрити бібліотеку C ++ на C

Question 5

Я думаю, ви зможете отримати деякі ідеї щодо напрямку та / або, можливо, використовувати безпосередньо SWIG . Я думаю, що перегляд кількох прикладів принаймні дасть вам уявлення про те, які речі слід враховувати, переносячи один API в інший. Вправа може бути корисною.

SWIG - це інструмент розробки програмного забезпечення, який пов'язує програми, написані на C та C ++, з різними мовами програмування високого рівня. SWIG використовується з різними типами мов, включаючи загальні мови сценаріїв, такі як Perl, PHP, Python, Tcl та Ruby. Список підтримуваних мов також включає мови, що не підтримують сценаріїв, такі як C #, Common Lisp (CLISP, Allegro CL, CFFI, UFFI), Java, Lua, Modula-3, OCAML, Octave та R. Також кілька інтерпретованих та скомпільованих реалізацій схеми Guile, MzScheme, Chicken). SWIG найчастіше використовується для створення інтерпретованих або скомпільованих середовищ програмування високого рівня, користувальницьких інтерфейсів і як інструмент для тестування та прототипування програмного забезпечення C / C ++. SWIG також може експортувати своє дерево синтаксичного аналізу у вигляді s-виразів XML та Lisp. SWIG можна вільно використовувати, розповсюджувати,

Question 6

Просто замініть концепцію об’єкта на void *(яку часто називають непрозорим типом у бібліотеках, орієнтованих на C) і повторно використовуйте все, що ви знаєте з C ++.

Question 7

Я думаю, що використання SWIG є найкращою відповіддю ... не тільки це дозволяє уникнути винаходу колеса, але воно є надійним, а також сприяє наступності в розробці, а не вирішенні проблеми.

Проблеми високої частоти потрібно вирішувати шляхом довгострокового вирішення.