Jason Larabie 14f79910ee
Update C++ module bindings to RawModuleDefV10 (#4461)
# Description of Changes
- Migrated the C++ module-definition assembly path to V10-first
internals:
      - Added v10_builder and module_type_registration systems.
- Switched Module::__describe_module__ to serialize RawModuleDef with
V10 payload.
      - Updated macro registration pipeline to register through V10
- Added explicit naming support across macro surface (*_NAMED variants
for reducer/procedure/
        view and field/index macros).
- Reworked multi-column index macros (FIELD_MultiColumnIndex,
FIELD_MultiColumnIndex_NAMED) with
        migration alias.
- Added SPACETIMEDB_SETTING_CASE_CONVERSION(...) to support case
conversion policy
- Error-path hardening by adding explicit constraint-registration error
tracking and preinit validation
  - Codegen updates:
      - Updated C++ moduledef regen to V10 builder types.
- Adjusted C++ codegen duplicate-variant wrapper generation to emit
proper product-type
        wrappers.
  - Test/harness updates:
- type-isolation-test runner now defaults to focused V10 regression
checks; --v9 runs broader
        legacy/full suite.
      - Added focused modules for positive/negative V10 checks:
          - test_multicolumn_index_valid
          - error_multicolumn_missing_field
          - error_default_missing_field
- Re-enabled C++ paths in sdks/rust/tests/test.rs procedure/view/test
suites.

# API and ABI breaking changes

- Refactor of the underlying module definition
- New *_NAMED variant macros for explicit canonical naming
- FIELD_NamedMultiColumnIndex renamed to FIELD_MultiColumnIndex

# Expected complexity level and risk

3 - Large set of changes moving over to V10 with underlying changes to
make future updates a little easier

# Testing
- [x] Ran the type isolation test and expanded it
- [x] Ran the spacetimedb-sdk test framework to confirm no more drift
between C++ and other module languages
- [x] Ran Unreal test suite though not really applicable
- [x] New app creation with `spacetime init --template basic-cpp`
- [x] Ran describe module tests against Rust + C# matching with C++ on
the /modules/sdk-test* modules to find any possible mis-alignment

# Review
- [x] Another look at the new features with C++
- [x] Thoughts on *_NAMED macros, I couldn't come up with a better
solution with C++20
2026-02-28 07:05:50 +00:00

57 lines
1.8 KiB
Rust

//! This script is used to generate the C++ bindings for the `RawModuleDef` type.
//! Run `cargo run --example regen-cpp-moduledef` to update C++ bindings whenever the module definition changes.
#![allow(clippy::disallowed_macros)]
use fs_err as fs;
use spacetimedb_codegen::{cpp, generate, CodegenOptions, OutputFile};
use spacetimedb_lib::db::raw_def::v10::{RawModuleDefV10, RawModuleDefV10Builder};
use spacetimedb_lib::RawModuleDef;
use spacetimedb_schema::def::ModuleDef;
use std::path::Path;
fn main() -> anyhow::Result<()> {
let mut builder = RawModuleDefV10Builder::new();
builder.add_type::<RawModuleDef>();
builder.add_type::<RawModuleDefV10>();
let module = builder.finish();
// Build relative path from the codegen crate to the C++ Module Library autogen directory
let manifest_dir = env!("CARGO_MANIFEST_DIR");
let dir = Path::new(manifest_dir)
.parent()
.unwrap()
.join("bindings-cpp/include/spacetimedb/internal/autogen");
println!("Target directory path: {}", dir.display());
// Create the autogen directory if it doesn't exist
if dir.exists() {
fs::remove_dir_all(&dir)?;
}
fs::create_dir_all(&dir)?;
let module: ModuleDef = module.try_into()?;
generate(
&module,
&cpp::Cpp {
namespace: "SpacetimeDB::Internal",
},
&CodegenOptions::default(),
)
.into_iter()
.try_for_each(|OutputFile { filename, code }| {
// Remove any prefix and just use the filename
let filename = if let Some(name) = filename.strip_prefix("Types/") {
name
} else {
&filename
};
println!("Generating {}", filename);
fs::write(dir.join(filename), code)
})?;
println!("C++ autogen files written to: {}", dir.display());
Ok(())
}