logos-messaging/nim-ffi
1
0
Fork 0
mirror of https://github.com/logos-messaging/nim-ffi.git synced 2026-05-06 18:29:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

better comments about where genBindings() should be invoked

Browse Source
This commit is contained in:
Ivan FB 2026-05-04 11:18:32 +02:00
parent 0305c1ace7
commit 558356149b
No known key found for this signature in database
GPG Key ID: DF0C67A04C543270
2 changed files with 19 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
examples/nim_timer/nim_timer.nim
View File

@ -65,6 +65,13 @@ proc nimtimerComplex*(
return
ok(ComplexResponse(summary: summary, itemCount: count, hasNote: req.note.isSome))
# --- genBindings() must come AFTER every {.ffi.} / {.ffiCtor.} annotation ---
# Each pragma populates ffiProcRegistry / ffiTypeRegistry at compile time as
# the compiler processes the AST. genBindings() reads those registries to emit
# the binding files, so placing it any earlier would produce incomplete output.
# In a multi-file library, import all sub-modules first and call genBindings()
# once, at the bottom of the top-level compilation-root file.
# This call is a no-op unless -d:ffiGenBindings is passed to the compiler.
genBindings() # reads -d:ffiOutputDir, -d:ffiNimSrcRelPath, -d:targetLang from compile flags
proc nimtimer_destroy*(ctx: pointer) {.dynlib, exportc, cdecl, raises: [].} =

14
ffi/internal/ffi_macro.nim
View File

@ -1461,8 +1461,18 @@ macro genBindings*(
outputDir: static[string] = ffiOutputDir,
nimSrcRelPath: static[string] = ffiNimSrcRelPath,
): untyped =
## Generates binding files for the language set by -d:targetLang=<lang>.
## Supported values: "rust" (default), "cpp" (case-insensitive).
## Emits C++ or Rust binding files from the compile-time FFI registries.
##
## PLACEMENT REQUIREMENT: genBindings() must be called AFTER every {.ffi.}
## and {.ffiCtor.} annotation in the compilation unit. Each pragma populates
## ffiProcRegistry and ffiTypeRegistry as the compiler expands the AST;
## calling genBindings() earlier produces incomplete bindings.
##
## In a single-file library, place it at the bottom of the file.
## In a multi-file library, import all sub-modules first and call
## genBindings() once at the bottom of the top-level compilation-root file.
##
## Supported languages (-d:targetLang): "rust" (default), "cpp".
## Output path and nim source path default to -d:ffiOutputDir and
## -d:ffiNimSrcRelPath, or can be passed as explicit arguments.
## This macro is a no-op unless -d:ffiGenBindings is set.