Generators API¶
Generators convert the intermediate representation (IR) into target language code. Each generator is responsible for producing idiomatic code in its target language.
Overview¶
The generator architecture allows extending Polyglot FFI to new target languages without modifying the parser or IR. Each generator implements the same interface but produces different output.
Ctypes Generator¶
Generates OCaml ctypes type and function descriptions.
polyglot_ffi.generators.ctypes_gen.CtypesGenerator
¶
Generate OCaml ctypes binding code.
Source code in src/polyglot_ffi/generators/ctypes_gen.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | |
Functions¶
generate_type_description(module)
¶
Generate type_description.ml.
Basic boilerplate only (no complex types).
Source code in src/polyglot_ffi/generators/ctypes_gen.py
generate_function_description(module)
¶
Generate function_description.ml with foreign function declarations.
Source code in src/polyglot_ffi/generators/ctypes_gen.py
Usage Example¶
from polyglot_ffi.parsers.ocaml import parse_mli_file
from polyglot_ffi.generators.ctypes_gen import CtypesGenerator
# Parse OCaml interface
module = parse_mli_file(Path("crypto.mli"))
# Generate ctypes bindings
generator = CtypesGenerator()
type_desc = generator.generate_type_description(module)
func_desc = generator.generate_function_description(module)
# Write to files
Path("type_description.ml").write_text(type_desc)
Path("function_description.ml").write_text(func_desc)
Generated Output¶
For val encrypt : string -> string:
(* type_description.ml *)
open Ctypes
let string = Ctypes.string
(* function_description.ml *)
open Ctypes
let encrypt = foreign "ml_encrypt" (string @-> returning string)
C Stubs Generator¶
Generates memory-safe C wrapper code with proper CAMLparam/CAMLreturn macros.
polyglot_ffi.generators.c_stubs_gen.CStubGenerator
¶
Generate C wrapper code for OCaml functions.
Source code in src/polyglot_ffi/generators/c_stubs_gen.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 | |
Functions¶
generate_stubs(module, module_name)
¶
Generate C stub implementation file.
Source code in src/polyglot_ffi/generators/c_stubs_gen.py
generate_header(module, module_name)
¶
Generate C header file.
Source code in src/polyglot_ffi/generators/c_stubs_gen.py
Usage Example¶
from polyglot_ffi.generators.c_stubs_gen import CStubGenerator
generator = CStubGenerator()
stubs = generator.generate_stubs(module, "crypto")
header = generator.generate_header(module, "crypto")
Path("stubs.c").write_text(stubs)
Path("stubs.h").write_text(header)
Generated Output¶
For val encrypt : string -> string:
/* stubs.c */
#include <caml/mlvalues.h>
#include <caml/memory.h>
#include <caml/alloc.h>
#include "stubs.h"
CAMLprim value ml_encrypt(value input) {
CAMLparam1(input);
CAMLlocal1(result);
char* c_input = String_val(input);
char* c_result = encrypt(c_input);
result = caml_copy_string(c_result);
CAMLreturn(result);
}
/* stubs.h */
#ifndef CRYPTO_STUBS_H
#define CRYPTO_STUBS_H
#include <caml/mlvalues.h>
CAMLprim value ml_encrypt(value input);
#endif
Python Generator¶
Generates type-safe Python wrapper modules with type hints.
polyglot_ffi.generators.python_gen.PythonGenerator
¶
Generate Python wrapper code.
Source code in src/polyglot_ffi/generators/python_gen.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 | |
Functions¶
generate(module, module_name)
¶
Generate Python wrapper module.
Source code in src/polyglot_ffi/generators/python_gen.py
Usage Example¶
from polyglot_ffi.generators.python_gen import PythonGenerator
generator = PythonGenerator()
wrapper = generator.generate(module, "crypto")
Path("crypto_py.py").write_text(wrapper)
Generated Output¶
For val encrypt : string -> string:
"""
Auto-generated Python bindings for crypto.
Generated by Polyglot FFI.
"""
import ctypes
from pathlib import Path
from typing import Optional
# Load shared library
_lib_path = Path(__file__).parent / "libcrypto.so"
_lib = ctypes.CDLL(str(_lib_path))
# Configure function signatures
_lib.ml_encrypt.argtypes = [ctypes.c_char_p]
_lib.ml_encrypt.restype = ctypes.c_char_p
def encrypt(input: str) -> str:
"""Encrypt a string."""
result = _lib.ml_encrypt(input.encode('utf-8'))
if result is None:
raise RuntimeError("encrypt returned NULL")
return result.decode('utf-8')
Dune Generator¶
Generates Dune build system configuration.
polyglot_ffi.generators.dune_gen.DuneGenerator
¶
Generate Dune build configuration files.
Source code in src/polyglot_ffi/generators/dune_gen.py
10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | |
Functions¶
generate_dune(module_name, ocaml_libraries=None)
¶
Generate dune file for the bindings library.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
module_name
|
str
|
Name of the module |
required |
ocaml_libraries
|
Optional[List[str]]
|
Additional OCaml libraries to link (e.g., ['str', 'unix']) |
None
|
Source code in src/polyglot_ffi/generators/dune_gen.py
generate_dune_project(module_name)
¶
Generate dune-project file.
Source code in src/polyglot_ffi/generators/dune_gen.py
Usage Example¶
from polyglot_ffi.generators.dune_gen import DuneGenerator
generator = DuneGenerator()
dune = generator.generate_dune("crypto")
dune_project = generator.generate_dune_project("crypto")
Path("dune").write_text(dune)
Path("dune-project").write_text(dune_project)
Generated Output¶
; dune
(library
(name crypto)
(libraries ctypes ctypes.foreign)
(foreign_stubs
(language c)
(names stubs)))
; dune-project
(lang dune 3.0)
(name crypto)
Complete Generation Workflow¶
from pathlib import Path
from polyglot_ffi.parsers.ocaml import parse_mli_file
from polyglot_ffi.generators.ctypes_gen import CtypesGenerator
from polyglot_ffi.generators.c_stubs_gen import CStubGenerator
from polyglot_ffi.generators.python_gen import PythonGenerator
from polyglot_ffi.generators.dune_gen import DuneGenerator
# Parse
module = parse_mli_file(Path("crypto.mli"))
# Generate all artifacts
output_dir = Path("generated")
output_dir.mkdir(exist_ok=True)
# OCaml ctypes
ctypes_gen = CtypesGenerator()
(output_dir / "type_description.ml").write_text(
ctypes_gen.generate_type_description(module)
)
(output_dir / "function_description.ml").write_text(
ctypes_gen.generate_function_description(module)
)
# C stubs
c_gen = CStubGenerator()
(output_dir / "stubs.c").write_text(
c_gen.generate_stubs(module, "crypto")
)
(output_dir / "stubs.h").write_text(
c_gen.generate_header(module, "crypto")
)
# Python wrapper
py_gen = PythonGenerator()
(output_dir / "crypto_py.py").write_text(
py_gen.generate(module, "crypto")
)
# Build system
dune_gen = DuneGenerator()
(output_dir / "dune").write_text(
dune_gen.generate_dune("crypto")
)
(output_dir / "dune-project").write_text(
dune_gen.generate_dune_project("crypto")
)
print(f"Generated {len(module.functions)} function bindings")
Type Mapping¶
All generators use the type registry for consistent type mappings:
from polyglot_ffi.type_system.registry import get_default_registry
from polyglot_ffi.ir.types import STRING, INT, ir_option
registry = get_default_registry()
# Primitive types
registry.get_mapping(STRING, "python") # "str"
registry.get_mapping(INT, "python") # "int"
# Complex types
opt_string = ir_option(STRING)
registry.get_mapping(opt_string, "python") # "Optional[str]"
Adding Custom Generators¶
To add support for a new target language:
from polyglot_ffi.ir.types import IRModule
class RustGenerator:
"""Generate Rust FFI bindings."""
def generate(self, module: IRModule, module_name: str) -> str:
"""Generate Rust code from IR."""
lines = [
f"// Auto-generated Rust bindings for {module_name}",
"",
"use std::ffi::CString;",
"use std::os::raw::c_char;",
"",
]
for func in module.functions:
# Generate extern declaration
lines.append(f"extern \"C\" {{")
lines.append(f" fn ml_{func.name}(...) -> ...;")
lines.append("}")
# Generate safe wrapper
lines.append(f"pub fn {func.name}(...) -> ... {{")
lines.append(f" unsafe {{ ml_{func.name}(...) }}")
lines.append("}")
lines.append("")
return "\n".join(lines)
Performance¶
Generators are highly optimized:
- Ctypes: ~0.0001ms per generation (extremely fast)
- C Stubs: ~0.009ms per generation
- Python: ~0.008ms per generation
- Complete workflow: ~0.07ms for 6 functions
All generators can be run in parallel for additional speedup.
See Also¶
- Parser API - Parsing OCaml files
- IR Types - Intermediate representation
- Type System - Type mappings