C言語互換を保つC++コードの書き方：extern “C”・ABI・ヘッダ設計のベストプラクティス

// CコンパイラでもC++コンパイラでもインクルード可能な公開ヘッダ
#ifndef MYLIB_H
#define MYLIB_H

// バージョンマクロ
#define MYLIB_VERSION_MAJOR 1
#define MYLIB_VERSION_MINOR 0
#define MYLIB_VERSION_PATCH 0

// 可視性と呼び出し規約
#if defined(_WIN32) || defined(__CYGWIN__)
  #if defined(MYLIB_SHARED)
    #if defined(MYLIB_BUILD)
      #define MYLIB_API __declspec(dllexport)
    #else
      #define MYLIB_API __declspec(dllimport)
    #endif
  #else
    #define MYLIB_API
  #endif
  // 既定は__cdecl。必要ならビルド時にMYLIB_USE_STDCALLを定義
  #ifdef MYLIB_USE_STDCALL
    #define MYLIB_CALL __stdcall
  #else
    #define MYLIB_CALL __cdecl
  #endif
#else
  #if defined(MYLIB_SHARED)
    #define MYLIB_API __attribute__((visibility("default")))
  #else
    #define MYLIB_API
  #endif
  #define MYLIB_CALL
#endif

#include <stddef.h>  // size_t
#include <stdint.h>  // int32_t, int64_t

#ifdef __cplusplus
extern "C" {
#endif

// 不完全型で実装を隠す
typedef struct mylib_context mylib_context;

// エラーコード（例外は使わない）
typedef enum mylib_status {
  MYLIB_OK = 0,
  MYLIB_EINVAL = 1,
  MYLIB_EOOM = 2,      // out-of-memory
  MYLIB_EINTERNAL = 3  // その他内部エラー
} mylib_status;

// コンテキスト生成・破棄（所有権は呼び出し側が持つ）
MYLIB_API mylib_status MYLIB_CALL mylib_create(mylib_context** out_ctx);
MYLIB_API void         MYLIB_CALL mylib_destroy(mylib_context* ctx);

// 設定と計算（in/out契約を明確化）
MYLIB_API mylib_status MYLIB_CALL mylib_set_scale(mylib_context* ctx, int32_t scale);
MYLIB_API mylib_status MYLIB_CALL mylib_sum_scaled(
    mylib_context* ctx,
    const int32_t* data, size_t n,
    int64_t* out_sum);

#ifdef __cplusplus
} // extern "C"
#endif

#endif // MYLIB_H

// C++で実装しCリンケージでエクスポート
#include "mylib.h"
#include <memory>
#include <vector>
#include <new>      // std::bad_alloc
#include <exception>

// 内部実装はC++の型で自由に設計
namespace mylib_detail {
  class ContextImpl {
  public:
    void set_scale(int32_t s) { scale_ = s; }
    int64_t sum_scaled(const int32_t* data, size_t n) const {
      int64_t acc = 0;
      for (size_t i = 0; i < n; ++i) {
        acc += static_cast<int64_t>(data[i]) * static_cast<int64_t>(scale_);
      }
      return acc;
    }
  private:
    int32_t scale_ = 1;
  };

  static mylib_status to_status_from_exception() noexcept {
    try {
      throw; // 直前の例外を再スローして型を判定
    } catch (const std::bad_alloc&) {
      return MYLIB_EOOM;
    } catch (...) {
      return MYLIB_EINTERNAL;
    }
  }
}

// Opaque pointerの実体（サイズやレイアウトは非公開）
struct mylib_context {
  std::unique_ptr<mylib_detail::ContextImpl> pimpl;
};

extern "C" {

MYLIB_API mylib_status MYLIB_CALL mylib_create(mylib_context** out_ctx) {
  if (!out_ctx) return MYLIB_EINVAL;
  try {
    // 例外安全：unique_ptrで確実に解放
    std::unique_ptr<mylib_context> ctx(new mylib_context);
    ctx->pimpl = std::make_unique<mylib_detail::ContextImpl>();
    *out_ctx = ctx.release();
    return MYLIB_OK;
  } catch (...) {
    return mylib_detail::to_status_from_exception();
  }
}

MYLIB_API void MYLIB_CALL mylib_destroy(mylib_context* ctx) {
  // 例外を投げないこと（noexcept違反はstd::terminate）
  delete ctx; // unique_ptrごと破棄され実装も解放
}

MYLIB_API mylib_status MYLIB_CALL mylib_set_scale(mylib_context* ctx, int32_t scale) {
  if (!ctx) return MYLIB_EINVAL;
  try {
    ctx->pimpl->set_scale(scale);
    return MYLIB_OK;
  } catch (...) {
    return mylib_detail::to_status_from_exception();
  }
}

MYLIB_API mylib_status MYLIB_CALL mylib_sum_scaled(
    mylib_context* ctx, const int32_t* data, size_t n, int64_t* out_sum) {
  if (!ctx || (!data && n != 0) || !out_sum) return MYLIB_EINVAL;
  try {
    *out_sum = ctx->pimpl->sum_scaled(data, n);
    return MYLIB_OK;
  } catch (...) {
    return mylib_detail::to_status_from_exception();
  }
}

} // extern "C"

/* ELF向けシンボルバージョン */
MYLIB_1.0 {
  global:
    mylib_create;
    mylib_destroy;
    mylib_set_scale;
    mylib_sum_scaled;
  local:
    *;
};

g++ -shared -fvisibility=hidden -Wl,--version-script=mylib.map -o libmylib.so mylib.cpp

; mylib.def — エクスポートシンボルの明示
LIBRARY "mylib"
EXPORTS
  mylib_create
  mylib_destroy
  mylib_set_scale
  mylib_sum_scaled

# Cとしてヘッダと最小プログラムをビルド
gcc -std=c11 -Wall -Wextra -Werror -c test.c -o test.o

// CからC++実装のライブラリを利用
#include "mylib.h"
#include <stdio.h>
#include <inttypes.h>

int main(void) {
  mylib_context* ctx = NULL;
  if (mylib_create(&ctx) != MYLIB_OK) {
    fprintf(stderr, "create failed\n");
    return 1;
  }
  mylib_set_scale(ctx, 2);

  int32_t data[] = {1, 2, 3};
  int64_t sum = 0;
  if (mylib_sum_scaled(ctx, data, 3, &sum) != MYLIB_OK) {
    fprintf(stderr, "sum_scaled failed\n");
    mylib_destroy(ctx);
    return 2;
  }
  printf("sum_scaled = %" PRId64 "\n", sum);
  mylib_destroy(ctx);
  return 0;
}

nm -D --defined-only libmylib.so | grep mylib_

0000000000001120 T mylib_create
0000000000001160 T mylib_destroy
00000000000011a0 T mylib_set_scale
00000000000011f0 T mylib_sum_scaled

# mylib.pc
prefix=/usr
exec_prefix=${prefix}
libdir=${exec_prefix}/lib
includedir=${prefix}/include

Name: mylib
Description: Example C-compatible C++ library
Version: 1.0.0
Libs: -L${libdir} -lmylib
Cflags: -I${includedir}