kingchencandGitHub
91e05e3c26
## What
Introduces `wickra-c` — a `cdylib` + `staticlib` that exposes the Rust core over a **C ABI**. This is the hub every C-capable language (C, C++, Go, C#, Java, R) links against, instead of re-wiring each indicator natively. The native Python/Node/WASM bindings are untouched; this is purely additive, for ecosystems without first-class Rust tooling.
## Scope (foundation slice)
This PR deliberately validates the **whole pipeline end to end with one indicator (SMA)** before scaling to all 514, so the CI / cross-OS / header-drift mechanics are proven green first.
- Opaque `*mut T` handles; `wickra_<ind>_{new,update,batch,reset,free}`.
- NaN sentinel for warmup / NULL handles; caller-owned batch buffers; every function NULL-safe.
- cbindgen generates and commits `bindings/c/include/wickra.h` with opaque handle typedefs.
- A C smoke example (`examples/c/`) links the header + compiled library and runs (CMake + ctest).
- A `c-abi` CI job builds the library and runs the smoke test on **Linux, macOS and Windows**, plus a header drift check on Linux.
## Notes
- The per-indicator FFI blocks are plain `#[no_mangle]` functions, **not** a macro: cbindgen cannot see macro-generated functions on stable Rust (macro expansion needs nightly), so the blocks are written literally and will be generated mechanically by the ScriptHelpers `capi` wrapper in a follow-up (same model as the committed-but-generated Node `index.js`).
- `bindings/c` cannot inherit the workspace `forbid(unsafe_code)` lint (the C boundary needs raw pointers), so it mirrors every workspace lint and only relaxes `unsafe_code`. The Rust core stays `unsafe`-forbidden.
## Follow-ups (separate PRs)
- ScriptHelpers `capi` generator + wire the scalar family (~235).
- Hand-written blocks for multi-output / custom-input / bars (~279).
- Docs consistency wave (README / docs / webpage: Python·Node·WASM·Rust → +C).
- Release wiring (native-lib matrix + header/lib GH-release assets) — gated.
54 lines
2.1 KiB
CMake
54 lines
2.1 KiB
CMake
cmake_minimum_required(VERSION 3.15)
|
|
project(wickra_c_examples C CXX)
|
|
|
|
# Directory holding the compiled Wickra C library (cargo output), e.g.
|
|
# <workspace>/target/release. Override with -DWICKRA_LIB_DIR=/path/to/target/release.
|
|
if(NOT DEFINED WICKRA_LIB_DIR)
|
|
set(WICKRA_LIB_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../target/release")
|
|
endif()
|
|
set(WICKRA_INCLUDE_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../../bindings/c/include")
|
|
|
|
# Pick the right link target per platform/toolchain.
|
|
# - MSVC links the generated import library (wickra.dll.lib).
|
|
# - MinGW/gcc on Windows links the DLL directly.
|
|
# - Unix links the shared object / dylib.
|
|
if(WIN32)
|
|
set(WICKRA_RUNTIME "${WICKRA_LIB_DIR}/wickra.dll")
|
|
if(MSVC)
|
|
set(WICKRA_LINK_LIB "${WICKRA_LIB_DIR}/wickra.dll.lib")
|
|
else()
|
|
set(WICKRA_LINK_LIB "${WICKRA_LIB_DIR}/wickra.dll")
|
|
endif()
|
|
elseif(APPLE)
|
|
set(WICKRA_LINK_LIB "${WICKRA_LIB_DIR}/libwickra.dylib")
|
|
else()
|
|
set(WICKRA_LINK_LIB "${WICKRA_LIB_DIR}/libwickra.so")
|
|
endif()
|
|
|
|
enable_testing()
|
|
|
|
# Build one example, link it to the Wickra library, run it as a ctest. On Windows
|
|
# the DLL is copied next to the executable so the loader finds it at run time.
|
|
function(add_wickra_example name source)
|
|
add_executable(${name} ${source})
|
|
target_include_directories(${name} PRIVATE "${WICKRA_INCLUDE_DIR}")
|
|
target_link_libraries(${name} PRIVATE "${WICKRA_LINK_LIB}")
|
|
if(UNIX AND NOT APPLE)
|
|
target_link_libraries(${name} PRIVATE m)
|
|
endif()
|
|
if(WIN32)
|
|
add_custom_command(TARGET ${name} POST_BUILD
|
|
COMMAND ${CMAKE_COMMAND} -E copy_if_different
|
|
"${WICKRA_RUNTIME}" "$<TARGET_FILE_DIR:${name}>")
|
|
endif()
|
|
add_test(NAME ${name} COMMAND ${name})
|
|
if(NOT WIN32)
|
|
set_tests_properties(${name} PROPERTIES
|
|
ENVIRONMENT "LD_LIBRARY_PATH=${WICKRA_LIB_DIR};DYLD_LIBRARY_PATH=${WICKRA_LIB_DIR}")
|
|
endif()
|
|
endfunction()
|
|
|
|
add_wickra_example(smoke smoke.c) # links the boundary, asserts values
|
|
add_wickra_example(streaming streaming.c) # runnable streaming demo
|
|
add_wickra_example(cpp_smoke smoke.cpp) # C++ RAII wrapper (wickra.hpp)
|