mirror of
https://github.com/logos-messaging/nim-ffi.git
synced 2026-05-17 15:49:27 +00:00
1eb8f2bdf8
The whole point of a generic generator is decoupling — this couples every consumer of nim-ffi to one specific project's Nim build conventions. Plumb these through genBindings() parameters or a config block.
55 lines
2.0 KiB
Nim
55 lines
2.0 KiB
Nim
## Compile-time metadata types for FFI binding generation.
|
|
## Populated by the {.ffiCtor.} and {.ffi.} macros and consumed by codegen.
|
|
|
|
type
|
|
FFIParamMeta* = object
|
|
name*: string # Nim param name, e.g. "req"
|
|
typeName*: string # Nim type name, e.g. "EchoRequest"
|
|
isPtr*: bool # true if the type is `ptr T`
|
|
|
|
FFIProcKind* = enum
|
|
ffiCtorKind
|
|
ffiFfiKind
|
|
ffiDtorKind
|
|
|
|
FFIProcMeta* = object
|
|
procName*: string # e.g. "nimtimer_echo"
|
|
libName*: string # library name, e.g. "nimtimer"
|
|
kind*: FFIProcKind
|
|
libTypeName*: string # e.g. "NimTimer"
|
|
extraParams*: seq[FFIParamMeta] # all params except the lib param
|
|
returnTypeName*: string # e.g. "EchoResponse", "string", "pointer"
|
|
returnIsPtr*: bool # true if return type is ptr T
|
|
isAsync*: bool
|
|
|
|
FFIFieldMeta* = object
|
|
name*: string # e.g. "delayMs"
|
|
typeName*: string # e.g. "int"
|
|
|
|
FFITypeMeta* = object
|
|
name*: string
|
|
fields*: seq[FFIFieldMeta]
|
|
|
|
# Compile-time registries populated by the macros
|
|
var ffiProcRegistry* {.compileTime.}: seq[FFIProcMeta]
|
|
var ffiTypeRegistry* {.compileTime.}: seq[FFITypeMeta]
|
|
var currentLibName* {.compileTime.}: string
|
|
|
|
# Target language for binding generation; override with -d:targetLang=cpp
|
|
const targetLang* {.strdefine.} = "rust"
|
|
|
|
# Output directory for generated bindings; set with -d:ffiOutputDir=path/to/dir
|
|
const ffiOutputDir* {.strdefine.} = ""
|
|
|
|
# Nim source path (relative to outputDir) embedded in generated build files;
|
|
# set with -d:ffiNimSrcRelPath=../relative/path.nim
|
|
const ffiNimSrcRelPath* {.strdefine.} = ""
|
|
|
|
# Whitespace-separated extra Nim compiler flags to bake into the generated
|
|
# build.rs / CMakeLists.txt for the project's own `nim c` invocation. The
|
|
# generator emits only the strictly-required flags (--app:lib, --noMain,
|
|
# --nimMainPrefix, -o:) by default; everything else (gc choice, log level,
|
|
# project-specific -d defines, etc.) is up to the caller. Example:
|
|
# -d:ffiNimBuildFlags="--mm:orc -d:chronicles_log_level=WARN"
|
|
const ffiNimBuildFlags* {.strdefine.} = ""
|