mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Ruslan Shestopalyuk
407fb5c238
Summary: [Changelog][Internal] This adds a method, `emitDeviceEvent` to the C++ API of TurboModules, which allows to make calls to JS's `RCTDeviceEventEmitter.emit` from a C++ TurboModules. This is a very common pattern, specifically for the VR apps, but not only for them - e.g. Desktop fork also has a [custom implementation for this](https://www.internalfb.com/code/fbsource/third-party/microsoft-fork-of-react-native/react-native-utils/RCTEventEmitter.cpp). Note that my original intent was to actually backport the latter, however there are some complications with wiring things in a robust way, without exposing too much stuff and relying on singletons or folly::dynamic. So I ended up adding it to the TurboModule API itself and use the scheduler/JSI facilities instead. This approach is arguably well self-contained, uses high level APIs, and shouldn't be abusable much. Since I was trying to avoid usage of folly::dynamic in this case, I used a kind of "value factory" pattern instead in order to send the arguments to the JS thread in a thread safe way (see [the discussion here](https://fb.workplace.com/groups/rn.fabric/permalink/1398711453593610/)). Reviewed By: christophpurrer Differential Revision: D43466326 fbshipit-source-id: a3cb8359d08a46421559edd0f854772863cb5c39
126 lines
3.3 KiB
C++
126 lines
3.3 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
|
|
|
|
#include <string>
|
|
#include <unordered_map>
|
|
|
|
#include <jsi/jsi.h>
|
|
|
|
#include <ReactCommon/CallInvoker.h>
|
|
|
|
namespace facebook {
|
|
namespace react {
|
|
|
|
/**
|
|
* For now, support the same set of return types as existing impl.
|
|
* This can be improved to support richer typed objects.
|
|
*/
|
|
enum TurboModuleMethodValueKind {
|
|
VoidKind,
|
|
BooleanKind,
|
|
NumberKind,
|
|
StringKind,
|
|
ObjectKind,
|
|
ArrayKind,
|
|
FunctionKind,
|
|
PromiseKind,
|
|
};
|
|
|
|
class TurboCxxModule;
|
|
class TurboModuleBinding;
|
|
|
|
/**
|
|
* Base HostObject class for every module to be exposed to JS
|
|
*/
|
|
class JSI_EXPORT TurboModule : public facebook::jsi::HostObject {
|
|
public:
|
|
TurboModule(std::string name, std::shared_ptr<CallInvoker> jsInvoker);
|
|
|
|
// Note: keep this method declared inline to avoid conflicts
|
|
// between RTTI and non-RTTI compilation units
|
|
facebook::jsi::Value get(
|
|
facebook::jsi::Runtime &runtime,
|
|
const facebook::jsi::PropNameID &propName) override {
|
|
{
|
|
std::string propNameUtf8 = propName.utf8(runtime);
|
|
auto p = methodMap_.find(propNameUtf8);
|
|
if (p == methodMap_.end()) {
|
|
// Method was not found, let JS decide what to do.
|
|
return facebook::jsi::Value::undefined();
|
|
} else {
|
|
return get(runtime, propName, p->second);
|
|
}
|
|
}
|
|
}
|
|
|
|
std::vector<facebook::jsi::PropNameID> getPropertyNames(
|
|
facebook::jsi::Runtime &runtime) override {
|
|
std::vector<jsi::PropNameID> result;
|
|
result.reserve(methodMap_.size());
|
|
for (auto it = methodMap_.cbegin(); it != methodMap_.cend(); ++it) {
|
|
result.push_back(jsi::PropNameID::forUtf8(runtime, it->first));
|
|
}
|
|
return result;
|
|
}
|
|
|
|
protected:
|
|
const std::string name_;
|
|
std::shared_ptr<CallInvoker> jsInvoker_;
|
|
|
|
struct MethodMetadata {
|
|
size_t argCount;
|
|
facebook::jsi::Value (*invoker)(
|
|
facebook::jsi::Runtime &rt,
|
|
TurboModule &turboModule,
|
|
const facebook::jsi::Value *args,
|
|
size_t count);
|
|
};
|
|
std::unordered_map<std::string, MethodMetadata> methodMap_;
|
|
|
|
using ArgFactory =
|
|
std::function<void(jsi::Runtime &runtime, std::vector<jsi::Value> &args)>;
|
|
|
|
/**
|
|
* Calls RCTDeviceEventEmitter.emit to JavaScript, with given event name and
|
|
* an optional list of arguments.
|
|
* If present, argFactory is a callback used to construct extra arguments,
|
|
* e.g.
|
|
*
|
|
* emitDeviceEvent(rt, "myCustomEvent",
|
|
* [](jsi::Runtime& rt, std::vector<jsi::Value>& args) {
|
|
* args.emplace_back(jsi::Value(true));
|
|
* args.emplace_back(jsi::Value(42));
|
|
* });
|
|
*/
|
|
void emitDeviceEvent(
|
|
jsi::Runtime &runtime,
|
|
const std::string &eventName,
|
|
ArgFactory argFactory = nullptr);
|
|
|
|
private:
|
|
friend class TurboCxxModule;
|
|
friend class TurboModuleBinding;
|
|
std::unique_ptr<jsi::Object> jsRepresentation_;
|
|
|
|
facebook::jsi::Value get(
|
|
facebook::jsi::Runtime &runtime,
|
|
const facebook::jsi::PropNameID &propName,
|
|
const MethodMetadata &meta);
|
|
};
|
|
|
|
/**
|
|
* An app/platform-specific provider function to get an instance of a module
|
|
* given a name.
|
|
*/
|
|
using TurboModuleProviderFunctionType =
|
|
std::function<std::shared_ptr<TurboModule>(const std::string &name)>;
|
|
|
|
} // namespace react
|
|
} // namespace facebook
|