mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
39d67737c0
Summary:
If a NativeModule requires main queue setup, its `getConstants()` method must be executed on the main thead. The legacy NativeModule infra takes care of this for us. With TurboModules, however, all synchronous methods, including `getConstants()`, execute on the JS thread. Therefore, if a TurboModule requires main queue setup, and exports constants, we must execute its `getConstants()` method body on the main queue explicitly.
**Notes:**
- The changes in this diff should be a noop when TurboModules is off, because `RCTUnsafeExecuteOnMainQueueSync` synchronously execute its block on the current thread if the current thread is the main thread.
- If a NativeModule doens't have the `requiresMainQueueSetup` method, but has the `constantsToExport` method, both NativeModules and TurboModules assume that it requires main queue setup.
## Script
```
const exec = require("../lib/exec");
const abspath = require("../lib/abspath");
const relpath = require("../lib/relpath");
const readFile = (filename) => require("fs").readFileSync(filename, "utf8");
const writeFile = (filename, content) =>
require("fs").writeFileSync(filename, content);
function main() {
const tmFiles = exec("cd ~/fbsource && xbgs -n 10000 -l constantsToExport")
.split("\n")
.filter(Boolean);
const filesWithoutConstantsToExport = [];
const filesWithConstantsToExportButNotGetConstants = [];
const filesExplicitlyNotRequiringMainQueueSetup = [];
tmFiles
.filter((filename) => {
if (filename.includes("microsoft-fork-of-react-native")) {
return false;
}
return /\.mm?$/.test(filename);
})
.map(abspath)
.forEach((filename) => {
const code = readFile(filename);
const relFilename = relpath(filename);
if (!/constantsToExport\s*{/.test(code)) {
filesWithoutConstantsToExport.push(relFilename);
return;
}
if (!/getConstants\s*{/.test(code)) {
filesWithConstantsToExportButNotGetConstants.push(relFilename);
return;
}
if (/requiresMainQueueSetup\s*{/.test(code)) {
const requiresMainQueueSetupRegex = /requiresMainQueueSetup\s*{\s*return\s+(?<requiresMainQueueSetup>YES|NO)/;
const requiresMainQueueSetupRegexMatch = requiresMainQueueSetupRegex.exec(
code
);
if (!requiresMainQueueSetupRegexMatch) {
throw new Error(
"Detected requiresMainQueueSetup method in file " +
relFilename +
" but was unable to parse the method return value"
);
}
const {
requiresMainQueueSetup,
} = requiresMainQueueSetupRegexMatch.groups;
if (requiresMainQueueSetup == "NO") {
filesExplicitlyNotRequiringMainQueueSetup.push(relFilename);
return;
}
}
const getConstantsTypeRegex = () => /-\s*\((?<type>.*)\)getConstants\s*{/;
const getConstantsTypeRegexMatch = getConstantsTypeRegex().exec(code);
if (!getConstantsTypeRegexMatch) {
throw new Error(
`Failed to parse return type of getConstants method in file ${relFilename}`
);
}
const getConstantsType = getConstantsTypeRegexMatch.groups.type;
const getConstantsBody = code
.split(getConstantsTypeRegex())[2]
.split("\n}")[0];
const newGetConstantsBody = `
__block ${getConstantsType} constants;
RCTUnsafeExecuteOnMainQueueSync(^{${getConstantsBody
.replace(/\n/g, "\n ")
.replace(/_bridge/g, "self->_bridge")
.replace(/return /g, "constants = ")}
});
return constants;
`;
writeFile(
filename,
code
.replace(getConstantsBody, newGetConstantsBody)
.replace("#import", "#import <React/RCTUtils.h>\n#import")
);
});
console.log("Files without constantsToExport: ");
filesWithoutConstantsToExport.forEach((file) => console.log(file));
console.log();
console.log("Files with constantsToExport but no getConstants: ");
filesWithConstantsToExportButNotGetConstants.forEach((file) =>
console.log(file)
);
console.log();
console.log("Files with requiresMainQueueSetup = NO: ");
filesExplicitlyNotRequiringMainQueueSetup.forEach((file) =>
console.log(file)
);
}
if (!module.parent) {
main();
}
```
Changelog: [Internal]
Reviewed By: fkgozali
Differential Revision: D21797048
fbshipit-source-id: a822a858fecdbe976e6197f8339e509dc7cd917f
218 lines
6.0 KiB
Plaintext
218 lines
6.0 KiB
Plaintext
/*
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import "RCTStatusBarManager.h"
|
|
#import "CoreModulesPlugins.h"
|
|
|
|
#import <React/RCTEventDispatcher.h>
|
|
#import <React/RCTLog.h>
|
|
#import <React/RCTUtils.h>
|
|
|
|
#if !TARGET_OS_TV
|
|
#import <FBReactNativeSpec/FBReactNativeSpec.h>
|
|
|
|
@implementation RCTConvert (UIStatusBar)
|
|
|
|
+ (UIStatusBarStyle)UIStatusBarStyle:(id)json RCT_DYNAMIC
|
|
{
|
|
static NSDictionary *mapping;
|
|
static dispatch_once_t onceToken;
|
|
dispatch_once(&onceToken, ^{
|
|
if (@available(iOS 13.0, *)) {
|
|
mapping = @{
|
|
@"default" : @(UIStatusBarStyleDefault),
|
|
@"light-content" : @(UIStatusBarStyleLightContent),
|
|
#if defined(__IPHONE_OS_VERSION_MAX_ALLOWED) && defined(__IPHONE_13_0) && \
|
|
__IPHONE_OS_VERSION_MAX_ALLOWED >= __IPHONE_13_0
|
|
@"dark-content" : @(UIStatusBarStyleDarkContent)
|
|
#else
|
|
@"dark-content": @(UIStatusBarStyleDefault)
|
|
#endif
|
|
};
|
|
|
|
} else {
|
|
mapping = @{
|
|
@"default" : @(UIStatusBarStyleDefault),
|
|
@"light-content" : @(UIStatusBarStyleLightContent),
|
|
@"dark-content" : @(UIStatusBarStyleDefault)
|
|
};
|
|
}
|
|
});
|
|
return _RCT_CAST(
|
|
UIStatusBarStyle,
|
|
[RCTConvertEnumValue("UIStatusBarStyle", mapping, @(UIStatusBarStyleDefault), json) integerValue]);
|
|
}
|
|
|
|
RCT_ENUM_CONVERTER(
|
|
UIStatusBarAnimation,
|
|
(@{
|
|
@"none" : @(UIStatusBarAnimationNone),
|
|
@"fade" : @(UIStatusBarAnimationFade),
|
|
@"slide" : @(UIStatusBarAnimationSlide),
|
|
}),
|
|
UIStatusBarAnimationNone,
|
|
integerValue);
|
|
|
|
@end
|
|
#endif
|
|
|
|
#if !TARGET_OS_TV
|
|
|
|
@interface RCTStatusBarManager () <NativeStatusBarManagerIOSSpec>
|
|
@end
|
|
|
|
#endif
|
|
|
|
@implementation RCTStatusBarManager
|
|
|
|
static BOOL RCTViewControllerBasedStatusBarAppearance()
|
|
{
|
|
static BOOL value;
|
|
static dispatch_once_t onceToken;
|
|
dispatch_once(&onceToken, ^{
|
|
value =
|
|
[[[NSBundle mainBundle] objectForInfoDictionaryKey:@"UIViewControllerBasedStatusBarAppearance"]
|
|
?: @YES boolValue];
|
|
});
|
|
|
|
return value;
|
|
}
|
|
|
|
RCT_EXPORT_MODULE()
|
|
|
|
+ (BOOL)requiresMainQueueSetup
|
|
{
|
|
return YES;
|
|
}
|
|
|
|
- (NSArray<NSString *> *)supportedEvents
|
|
{
|
|
return @[ @"statusBarFrameDidChange", @"statusBarFrameWillChange" ];
|
|
}
|
|
|
|
#if !TARGET_OS_TV
|
|
|
|
- (void)startObserving
|
|
{
|
|
NSNotificationCenter *nc = [NSNotificationCenter defaultCenter];
|
|
[nc addObserver:self
|
|
selector:@selector(applicationDidChangeStatusBarFrame:)
|
|
name:UIApplicationDidChangeStatusBarFrameNotification
|
|
object:nil];
|
|
[nc addObserver:self
|
|
selector:@selector(applicationWillChangeStatusBarFrame:)
|
|
name:UIApplicationWillChangeStatusBarFrameNotification
|
|
object:nil];
|
|
}
|
|
|
|
- (void)stopObserving
|
|
{
|
|
[[NSNotificationCenter defaultCenter] removeObserver:self];
|
|
}
|
|
|
|
- (dispatch_queue_t)methodQueue
|
|
{
|
|
return dispatch_get_main_queue();
|
|
}
|
|
|
|
- (void)emitEvent:(NSString *)eventName forNotification:(NSNotification *)notification
|
|
{
|
|
CGRect frame = [notification.userInfo[UIApplicationStatusBarFrameUserInfoKey] CGRectValue];
|
|
NSDictionary *event = @{
|
|
@"frame" : @{
|
|
@"x" : @(frame.origin.x),
|
|
@"y" : @(frame.origin.y),
|
|
@"width" : @(frame.size.width),
|
|
@"height" : @(frame.size.height),
|
|
},
|
|
};
|
|
[self sendEventWithName:eventName body:event];
|
|
}
|
|
|
|
- (void)applicationDidChangeStatusBarFrame:(NSNotification *)notification
|
|
{
|
|
[self emitEvent:@"statusBarFrameDidChange" forNotification:notification];
|
|
}
|
|
|
|
- (void)applicationWillChangeStatusBarFrame:(NSNotification *)notification
|
|
{
|
|
[self emitEvent:@"statusBarFrameWillChange" forNotification:notification];
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(getHeight : (RCTResponseSenderBlock)callback)
|
|
{
|
|
callback(@[ @{
|
|
@"height" : @(RCTSharedApplication().statusBarFrame.size.height),
|
|
} ]);
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(setStyle : (NSString *)style animated : (BOOL)animated)
|
|
{
|
|
UIStatusBarStyle statusBarStyle = [RCTConvert UIStatusBarStyle:style];
|
|
if (RCTViewControllerBasedStatusBarAppearance()) {
|
|
RCTLogError(@"RCTStatusBarManager module requires that the \
|
|
UIViewControllerBasedStatusBarAppearance key in the Info.plist is set to NO");
|
|
} else {
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
|
|
[RCTSharedApplication() setStatusBarStyle:statusBarStyle animated:animated];
|
|
}
|
|
#pragma clang diagnostic pop
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(setHidden : (BOOL)hidden withAnimation : (NSString *)withAnimation)
|
|
{
|
|
UIStatusBarAnimation animation = [RCTConvert UIStatusBarAnimation:withAnimation];
|
|
if (RCTViewControllerBasedStatusBarAppearance()) {
|
|
RCTLogError(@"RCTStatusBarManager module requires that the \
|
|
UIViewControllerBasedStatusBarAppearance key in the Info.plist is set to NO");
|
|
} else {
|
|
#pragma clang diagnostic push
|
|
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
|
|
[RCTSharedApplication() setStatusBarHidden:hidden withAnimation:animation];
|
|
#pragma clang diagnostic pop
|
|
}
|
|
}
|
|
|
|
RCT_EXPORT_METHOD(setNetworkActivityIndicatorVisible : (BOOL)visible)
|
|
{
|
|
RCTSharedApplication().networkActivityIndicatorVisible = visible;
|
|
}
|
|
|
|
- (facebook::react::ModuleConstants<JS::NativeStatusBarManagerIOS::Constants>)getConstants
|
|
{
|
|
__block facebook::react::ModuleConstants<JS::NativeStatusBarManagerIOS::Constants> constants;
|
|
RCTUnsafeExecuteOnMainQueueSync(^{
|
|
constants = facebook::react::typedConstants<JS::NativeStatusBarManagerIOS::Constants>({
|
|
.HEIGHT = RCTSharedApplication().statusBarFrame.size.height,
|
|
.DEFAULT_BACKGROUND_COLOR = folly::none,
|
|
});
|
|
});
|
|
|
|
return constants;
|
|
}
|
|
|
|
- (facebook::react::ModuleConstants<JS::NativeStatusBarManagerIOS::Constants>)constantsToExport
|
|
{
|
|
return (facebook::react::ModuleConstants<JS::NativeStatusBarManagerIOS::Constants>)[self getConstants];
|
|
}
|
|
|
|
- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
|
|
(const facebook::react::ObjCTurboModule::InitParams &)params
|
|
{
|
|
return std::make_shared<facebook::react::NativeStatusBarManagerIOSSpecJSI>(params);
|
|
}
|
|
|
|
#endif // TARGET_OS_TV
|
|
|
|
@end
|
|
|
|
Class RCTStatusBarManagerCls(void)
|
|
{
|
|
return RCTStatusBarManager.class;
|
|
}
|