Skip to content

Update doc: Simplify C++ TM struct generation #3930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
christophpurrer merged 1 commit into from
Nov 27, 2023
Merged

Update doc: Simplify C++ TM struct generation #3930

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/the-new-architecture/cxx-custom-types.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -257,10 +257,10 @@ This works - but is quite complex.
[**Codegen**](pillars-codegen.md) for C++ Turbo Native Modules does support struct generators, so you can simplify the code above in `NativeSampleModule.h` to:

```cpp
using CustomType = NativeSampleModuleBaseCustomType<std::string, bool, std::optional<int32_t>>;
using CustomType = NativeSampleModuleCustomType<std::string, bool, std::optional<int32_t>>;
template <>
struct Bridging<CustomType>
: NativeSampleModuleBaseCustomTypeBridging<std::string, bool, std::optional<int32_t>> {};
: NativeSampleModuleCustomTypeBridging<CustomType> {};
```

With `using CustomType` you declare a name for your concrete struct.
Expand All @@ -276,10 +276,9 @@ Without any custom conversion functions:

#### Base class

`NativeSampleModuleBaseCustomType` is an auto-generated template in your `AppSpecsJSI.h` which name is generated by:
`NativeSampleModuleCustomType` is an auto-generated template in your `AppSpecsJSI.h` which name is generated by:

- `NativeSampleModule` (name of C++ Turbo Native Module in the JavaScript spec) +
- `Base` (constant) +
- `CustomType` (name of type in the JavaScript spec)

The same naming schema applies to the necessary `Bridging` struct which is defined via `struct Bridging<CustomType>`.