mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
07261d0408
Summary: Pull Request resolved: https://github.com/facebook/react-native/pull/44630 Changelog: [General][Breaking] Use hasteModuleName for C++ Turbo Module structs This changes the names of C++ Turbo Modules structs to use the `hasteModuleName`. Example: `NativeMyAbcModule.js` with this spec: ``` export type ValueStruct = { x: number, y: string, z: ObjectStruct, }; export interface Spec extends TurboModule { +getValueStruct: () => ValueStruct } export default (TurboModuleRegistry.get<Spec>('MyAbcModuleCxx'): ?Spec); ``` Before now we generated a base C++ struct with the name: ``` MyAbcModuleCxxValueStruct ^^^ ``` Now the generate name is: ``` NativeMyAbcModuleValueStruct ^^^^^^ ``` ## Changes: - No `Cxx` injected anymore - Ensure base struct is `Native` prefixed (all RN JS TM specs start with it) ## Why? - The `Cxx` extension is a temporary hint to react-native-codegen to enable extra capabilities and might disappear eventually - The C++ base struct name should be 'stable' - The name of the exported TM JS spec `TurboModuleRegistry.get<Spec>(...)` is abritrary, the hasteName is not - The name of the RN JS TM spec must start with `Native` which better guarantees a consistent naming scheme for these generated base class - The C++ Turbo Module base class has now the same prefix as the generated structs - `NativeMyAbcModule` for the example above Reviewed By: cipolleschi Differential Revision: D57599257 fbshipit-source-id: 4fafe6c7e920737fa766bd7e8e68e521f608e775
217 lines
5.8 KiB
C++
217 lines
5.8 KiB
C++
/*
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#if __has_include(<ReactCodegen/AppSpecsJSI.h>) // CocoaPod headers on Apple
|
|
#include <ReactCodegen/AppSpecsJSI.h>
|
|
#elif __has_include("AppSpecsJSI.h") // Cmake headers on Android
|
|
#include "AppSpecsJSI.h"
|
|
#else // BUCK headers
|
|
#include <AppSpecs/AppSpecsJSI.h>
|
|
#endif
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <set>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace facebook::react {
|
|
|
|
#pragma mark - Structs
|
|
using ConstantsStruct =
|
|
NativeCxxModuleExampleConstantsStruct<bool, int32_t, std::string>;
|
|
|
|
template <>
|
|
struct Bridging<ConstantsStruct>
|
|
: NativeCxxModuleExampleConstantsStructBridging<ConstantsStruct> {};
|
|
|
|
using ObjectStruct = NativeCxxModuleExampleObjectStruct<
|
|
int32_t,
|
|
std::string,
|
|
std::optional<std::string>>;
|
|
|
|
template <>
|
|
struct Bridging<ObjectStruct>
|
|
: NativeCxxModuleExampleObjectStructBridging<ObjectStruct> {};
|
|
|
|
using ValueStruct =
|
|
NativeCxxModuleExampleValueStruct<double, std::string, ObjectStruct>;
|
|
|
|
template <>
|
|
struct Bridging<ValueStruct>
|
|
: NativeCxxModuleExampleValueStructBridging<ValueStruct> {};
|
|
|
|
#pragma mark - enums
|
|
enum class CustomEnumInt : int32_t { A = 23, B = 42 };
|
|
|
|
template <>
|
|
struct Bridging<CustomEnumInt> {
|
|
static CustomEnumInt fromJs(jsi::Runtime& rt, jsi::Value rawValue) {
|
|
auto value = static_cast<int32_t>(rawValue.asNumber());
|
|
if (value == 23) {
|
|
return CustomEnumInt::A;
|
|
} else if (value == 42) {
|
|
return CustomEnumInt::B;
|
|
} else {
|
|
throw jsi::JSError(rt, "Invalid enum value");
|
|
}
|
|
}
|
|
|
|
static jsi::Value toJs(jsi::Runtime& rt, CustomEnumInt value) {
|
|
return bridging::toJs(rt, static_cast<int32_t>(value));
|
|
}
|
|
};
|
|
|
|
#pragma mark - jsi::HostObjects
|
|
template <typename T>
|
|
class HostObjectWrapper : public jsi::HostObject {
|
|
public:
|
|
HostObjectWrapper(std::shared_ptr<T> value) : value_(std::move(value)) {}
|
|
|
|
std::shared_ptr<T> getValue() const {
|
|
return value_;
|
|
}
|
|
|
|
~HostObjectWrapper() override = default;
|
|
|
|
private:
|
|
std::shared_ptr<T> value_;
|
|
};
|
|
|
|
struct CustomHostObjectRef {
|
|
CustomHostObjectRef(std::string a, int32_t b) : a_(a), b_(b) {}
|
|
std::string a_;
|
|
int32_t b_;
|
|
};
|
|
|
|
using CustomHostObject = HostObjectWrapper<CustomHostObjectRef>;
|
|
|
|
#pragma mark - recursive objects
|
|
|
|
using BinaryTreeNode = NativeCxxModuleExampleBinaryTreeNode<int32_t>;
|
|
|
|
template <>
|
|
struct Bridging<BinaryTreeNode>
|
|
: NativeCxxModuleExampleBinaryTreeNodeBridging<BinaryTreeNode> {};
|
|
|
|
using GraphNode = NativeCxxModuleExampleGraphNode<std::string>;
|
|
|
|
template <>
|
|
struct Bridging<GraphNode>
|
|
: NativeCxxModuleExampleGraphNodeBridging<GraphNode> {};
|
|
|
|
#pragma mark - functional object properties
|
|
|
|
using MenuItem = NativeCxxModuleExampleMenuItem<
|
|
std::string,
|
|
AsyncCallback<std::string, bool>,
|
|
std::optional<std::string>>;
|
|
|
|
template <>
|
|
struct Bridging<MenuItem> : NativeCxxModuleExampleMenuItemBridging<MenuItem> {};
|
|
|
|
#pragma mark - RCTDeviceEventEmitter events
|
|
|
|
using CustomDeviceEvent = NativeCxxModuleExampleCustomDeviceEvent<
|
|
std::string,
|
|
int32_t,
|
|
std::optional<float>>;
|
|
|
|
template <>
|
|
struct Bridging<CustomDeviceEvent>
|
|
: NativeCxxModuleExampleCustomDeviceEventBridging<CustomDeviceEvent> {};
|
|
|
|
#pragma mark - implementation
|
|
class NativeCxxModuleExample
|
|
: public NativeCxxModuleExampleCxxSpec<NativeCxxModuleExample> {
|
|
public:
|
|
NativeCxxModuleExample(std::shared_ptr<CallInvoker> jsInvoker);
|
|
|
|
void getValueWithCallback(
|
|
jsi::Runtime& rt,
|
|
AsyncCallback<std::string> callback);
|
|
|
|
std::function<void()> setValueCallbackWithSubscription(
|
|
jsi::Runtime& rt,
|
|
AsyncCallback<std::string> callback);
|
|
|
|
std::vector<std::optional<ObjectStruct>> getArray(
|
|
jsi::Runtime& rt,
|
|
std::vector<std::optional<ObjectStruct>> arg);
|
|
|
|
bool getBool(jsi::Runtime& rt, bool arg);
|
|
|
|
ConstantsStruct getConstants(jsi::Runtime& rt);
|
|
|
|
CustomEnumInt getCustomEnum(jsi::Runtime& rt, CustomEnumInt arg);
|
|
|
|
std::shared_ptr<CustomHostObject> getCustomHostObject(jsi::Runtime& rt);
|
|
|
|
std::string consumeCustomHostObject(
|
|
jsi::Runtime& rt,
|
|
std::shared_ptr<CustomHostObject> arg);
|
|
|
|
BinaryTreeNode getBinaryTreeNode(jsi::Runtime& rt, BinaryTreeNode arg);
|
|
|
|
GraphNode getGraphNode(jsi::Runtime& rt, GraphNode arg);
|
|
|
|
NativeCxxModuleExampleCxxEnumInt getNumEnum(
|
|
jsi::Runtime& rt,
|
|
NativeCxxModuleExampleCxxEnumInt arg);
|
|
|
|
NativeCxxModuleExampleCxxEnumStr getStrEnum(
|
|
jsi::Runtime& rt,
|
|
NativeCxxModuleExampleCxxEnumNone arg);
|
|
|
|
std::map<std::string, std::optional<int32_t>> getMap(
|
|
jsi::Runtime& rt,
|
|
std::map<std::string, std::optional<int32_t>> arg);
|
|
|
|
double getNumber(jsi::Runtime& rt, double arg);
|
|
|
|
ObjectStruct getObject(jsi::Runtime& rt, ObjectStruct arg);
|
|
|
|
std::set<float> getSet(jsi::Runtime& rt, std::set<float> arg);
|
|
|
|
std::string getString(jsi::Runtime& rt, std::string arg);
|
|
|
|
std::string getUnion(jsi::Runtime& rt, float x, std::string y, jsi::Object z);
|
|
|
|
ValueStruct
|
|
getValue(jsi::Runtime& rt, double x, std::string y, ObjectStruct z);
|
|
|
|
AsyncPromise<std::string> getValueWithPromise(jsi::Runtime& rt, bool error);
|
|
|
|
std::optional<bool> getWithWithOptionalArgs(
|
|
jsi::Runtime& rt,
|
|
std::optional<bool> optionalArg);
|
|
|
|
void voidFunc(jsi::Runtime& rt);
|
|
|
|
void setMenu(jsi::Runtime& rt, MenuItem menuItem);
|
|
|
|
void emitCustomDeviceEvent(jsi::Runtime& rt, const std::string& eventName);
|
|
|
|
void voidFuncThrows(jsi::Runtime& rt);
|
|
|
|
ObjectStruct getObjectThrows(jsi::Runtime& rt, ObjectStruct arg);
|
|
|
|
AsyncPromise<jsi::Value> promiseThrows(jsi::Runtime& rt);
|
|
|
|
void voidFuncAssert(jsi::Runtime& rt);
|
|
|
|
ObjectStruct getObjectAssert(jsi::Runtime& rt, ObjectStruct arg);
|
|
|
|
AsyncPromise<jsi::Value> promiseAssert(jsi::Runtime& rt);
|
|
|
|
private:
|
|
std::optional<AsyncCallback<std::string>> valueCallback_;
|
|
};
|
|
|
|
} // namespace facebook::react
|