#include <FlutterEngine.h>

Inheritance diagram for FlutterEngine:

Instance Methods
(instancetype)	- init

(instancetype)	- initWithName:

(instancetype)	- initWithName:project:

(instancetype)	- initWithName:project:allowHeadlessExecution:

(instancetype)	- initWithName:project:allowHeadlessExecution:restorationEnabled:

(BOOL)	- run

(BOOL)	- runWithEntrypoint:

(BOOL)	- runWithEntrypoint:initialRoute:

(BOOL)	- runWithEntrypoint:libraryURI:

(BOOL)	- runWithEntrypoint:libraryURI:initialRoute:

(BOOL)	- runWithEntrypoint:libraryURI:initialRoute:entrypointArgs:

(void)	- destroyContext

(void)	- ensureSemanticsEnabled

(NSURL *observatoryUrl)	- FLUTTER_DEPRECATED

(nonnull instancetype)	- initWithName:project:

(nonnull instancetype)	- initWithName:project:allowHeadlessExecution:

(nonnull instancetype)	- NS_UNAVAILABLE

(BOOL)	- runWithEntrypoint:

(void)	- shutDownEngine

(instancetype)	- initWithName:project: `[implementation]`

(instancetype)	- initWithName:project:allowHeadlessExecution: `[implementation]`

(instancetype)	- initWithName:project:allowHeadlessExecution:restorationEnabled: `[implementation]`

(void)	- setUpSceneLifecycleNotifications: `[implementation]`

(void)	- setUpApplicationLifecycleNotifications: `[implementation]`

(void)	- recreatePlatformViewController `[implementation]`

(flutter::IOSRenderingAPI)	- platformViewsRenderingAPI `[implementation]`

(void)	- dealloc `[implementation]`

(flutter::Shell &)	- shell `[implementation]`

(fml::WeakNSObject< FlutterEngine >)	- getWeakNSObject `[implementation]`

(void)	- updateViewportMetrics: `[implementation]`

(void)	- dispatchPointerDataPacket: `[implementation]`

(fml::WeakPtr< flutter::PlatformView >)	- platformView `[implementation]`

(flutter::PlatformViewIOS *)	- iosPlatformView `[implementation]`

(fml::RefPtr< fml::TaskRunner >)	- platformTaskRunner `[implementation]`

(fml::RefPtr< fml::TaskRunner >)	- uiTaskRunner `[implementation]`

(fml::RefPtr< fml::TaskRunner >)	- rasterTaskRunner `[implementation]`

(void)	- sendKeyEvent:callback:userData: `[implementation]`

(void)	- setViewController: `[implementation]`

(void)	- attachView `[implementation]`

(void)	- setFlutterViewControllerWillDeallocObserver: `[implementation]`

(void)	- notifyViewControllerDeallocated `[implementation]`

(FlutterPlatformPlugin *)	- platformPlugin `[implementation]`

(std::shared_ptr< flutter::FlutterPlatformViewsController > &)	- platformViewsController `[implementation]`

(FlutterTextInputPlugin *)	- textInputPlugin `[implementation]`

(FlutterUndoManagerPlugin *)	- undoManagerPlugin `[implementation]`

(FlutterRestorationPlugin *)	- restorationPlugin `[implementation]`

(FlutterMethodChannel *)	- undoManagerChannel `[implementation]`

(FlutterMethodChannel *)	- scribbleChannel `[implementation]`

(FlutterMethodChannel *)	- spellCheckChannel `[implementation]`

(NSURL *)	- observatoryUrl `[implementation]`

(void)	- resetChannels `[implementation]`

(void)	- startProfiler `[implementation]`

(void)	- setUpChannels `[implementation]`

(void)	- maybeSetupPlatformViewChannels `[implementation]`

(flutter::Rasterizer::Screenshot)	- screenshot:base64Encode: `[implementation]`

(void)	- launchEngine:libraryURI:entrypointArgs: `[implementation]`

(void)	- setUpShell:withVMServicePublication: `[implementation]`

(BOOL)	- createShell:libraryURI:initialRoute: `[implementation]`

(void)	- updateDisplays `[implementation]`

(BOOL)	- runWithEntrypoint:libraryURI: `[implementation]`

(BOOL)	- runWithEntrypoint: `[implementation]`

(BOOL)	- runWithEntrypoint:initialRoute: `[implementation]`

(BOOL)	- runWithEntrypoint:libraryURI:initialRoute: `[implementation]`

(BOOL)	- runWithEntrypoint:libraryURI:initialRoute:entrypointArgs: `[implementation]`

(void)	- notifyLowMemory `[implementation]`

(void)	- flutterTextInputView:updateEditingClient:withState: `[implementation]`

(void)	- flutterTextInputView:updateEditingClient:withState:withTag: `[implementation]`

(void)	- flutterTextInputView:updateEditingClient:withDelta: `[implementation]`

(void)	- flutterTextInputView:updateFloatingCursor:withClient:withPosition: `[implementation]`

(void)	- flutterTextInputView:performAction:withClient: `[implementation]`

(void)	- flutterTextInputView:showAutocorrectionPromptRectForStart:end:withClient: `[implementation]`

(void)	- flutterTextInputView:willDismissEditMenuWithTextInputClient: `[implementation]`

(void)	- flutterTextInputView:showToolbar: `[implementation]`

(void)	- flutterTextInputPlugin:focusElement:atPoint:result: `[implementation]`

(void)	- flutterTextInputPlugin:requestElementsInRect:result: `[implementation]`

(void)	- flutterTextInputViewScribbleInteractionBegan: `[implementation]`

(void)	- flutterTextInputViewScribbleInteractionFinished: `[implementation]`

(void)	- flutterTextInputView:insertTextPlaceholderWithSize:withClient: `[implementation]`

(void)	- flutterTextInputView:removeTextPlaceholder: `[implementation]`

(void)	- flutterTextInputView:didResignFirstResponderWithTextInputClient: `[implementation]`

(void)	- handleUndoWithDirection: `[implementation]`

(UIView< UITextInput > *)	- activeTextInputView `[implementation]`

(NSUndoManager *)	- undoManager `[implementation]`

(flutter::Rasterizer::Screenshot)	- takeScreenshot:asBase64Encoded: `[implementation]`

(void)	- flutterViewAccessibilityDidCall `[implementation]`

(void)	- setBinaryMessenger: `[implementation]`

(void)	- sendOnChannel:message: `[implementation]`

(void)	- sendOnChannel:message:binaryReply: `[implementation]`

(NSObject< FlutterTaskQueue > *)	- makeBackgroundTaskQueue `[implementation]`
	TODO(gaaclarke): Remove optional when macos supports Background Platform Channels.

(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler: `[implementation]`

(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:taskQueue: `[implementation]`

(void)	- cleanUpConnection: `[implementation]`

(int64_t)	- registerTexture: `[implementation]`

(void)	- unregisterTexture: `[implementation]`

(void)	- textureFrameAvailable: `[implementation]`

(NSString *)	- lookupKeyForAsset: `[implementation]`

(NSString *)	- lookupKeyForAsset:fromPackage: `[implementation]`

(id< FlutterPluginRegistry >)	- pluginRegistry `[implementation]`

(NSObject< FlutterPluginRegistrar > *)	- registrarForPlugin: `[implementation]`

(BOOL)	- hasPlugin: `[implementation]`

(NSObject *)	- valuePublishedByPlugin: `[implementation]`

(void)	- applicationWillEnterForeground: `[implementation]`

(void)	- applicationDidEnterBackground: `[implementation]`

(void)	- flutterWillEnterForeground: `[implementation]`

(void)	- flutterDidEnterBackground: `[implementation]`

(void)	- onMemoryWarning: `[implementation]`

(void)	- setIsGpuDisabled: `[implementation]`

(void)	- onLocaleUpdated: `[implementation]`

(void)	- waitForFirstFrame:callback: `[implementation]`

(FlutterEngine *)	- spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs: `[implementation]`

(const flutter::ThreadHost &)	- threadHost `[implementation]`

(FlutterDartProject *)	- project `[implementation]`

(BOOL)	- isUsingImpeller `[implementation]`

(void)	- loadAOTData: `[implementation]`

(void)	- registerViewController:forIdentifier: `[implementation]`

(void)	- viewControllerViewDidLoad: `[implementation]`

(void)	- deregisterViewControllerForIdentifier: `[implementation]`

(void)	- shutDownIfNeeded `[implementation]`

(FlutterViewController *)	- viewControllerForIdentifier: `[implementation]`

(FlutterCompositor *)	- createFlutterCompositor `[implementation]`

(void)	- addViewController: `[implementation]`

(void)	- removeViewController: `[implementation]`

(BOOL)	- running `[implementation]`

(void)	- updateDisplayConfig: `[implementation]`

(NSArray< NSScreen * > *)	- screens `[implementation]`

(void)	- updateDisplayConfig `[implementation]`

(void)	- onSettingsChanged: `[implementation]`

(void)	- sendInitialSettings `[implementation]`

(FlutterEngineProcTable &)	- embedderAPI `[implementation]`

(nonnull NSString *)	- executableName `[implementation]`

(void)	- updateWindowMetricsForViewController: `[implementation]`

(void)	- sendPointerEvent: `[implementation]`

(void)	- sendKeyEvent:callback:userData: `[implementation]`

(void)	- setSemanticsEnabled: `[implementation]`

(void)	- dispatchSemanticsAction:toTarget:withData: `[implementation]`

(FlutterPlatformViewController *)	- platformViewController `[implementation]`

(void)	- sendUserLocales `[implementation]`

(void)	- engineCallbackOnPlatformMessage: `[implementation]`

(void)	- engineCallbackOnPreEngineRestart `[implementation]`

(void)	- onVSync: `[implementation]`

(void)	- setUpPlatformViewChannel `[implementation]`

(void)	- setUpAccessibilityChannel `[implementation]`

(void)	- setUpNotificationCenterListeners `[implementation]`

(void)	- addInternalPlugins `[implementation]`

(void)	- didUpdateMouseCursor: `[implementation]`

(void)	- applicationWillTerminate: `[implementation]`

(void)	- windowDidChangeScreen: `[implementation]`

(void)	- onAccessibilityStatusChanged: `[implementation]`

(void)	- handleAccessibilityEvent: `[implementation]`

(void)	- announceAccessibilityMessage:withPriority: `[implementation]`

(void)	- handleMethodCall:result: `[implementation]`

(void)	- playSystemSound: `[implementation]`

(NSDictionary *)	- getClipboardData: `[implementation]`

(void)	- setClipboardData: `[implementation]`

(BOOL)	- clipboardHasStrings `[implementation]`

(std::vector< std::string >)	- switches `[implementation]`

(FlutterThreadSynchronizer *)	- testThreadSynchronizer `[implementation]`

(void)	- setApplicationState: `[implementation]`

(void)	- handleWillBecomeActive: `[implementation]`

(void)	- handleWillResignActive: `[implementation]`

(void)	- handleDidChangeOcclusionState: `[implementation]`

(void)	- sendOnChannel:message: `[implementation]`

(void)	- sendOnChannel:message:binaryReply: `[implementation]`

(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler: `[implementation]`

(int64_t)	- registerTexture: `[implementation]`

(BOOL)	- registerTextureWithID: `[implementation]`

(BOOL)	- markTextureFrameAvailable: `[implementation]`

(BOOL)	- unregisterTextureWithID: `[implementation]`

(void)	- runTaskOnEmbedder: `[implementation]`

(void)	- postMainThreadTask:targetTimeInNanoseconds: `[implementation]`

(flutter::FlutterCompositor *)	- macOSCompositor `[implementation]`

(instancetype)	- initWithScenario:withCompletion:

(void)	- sceneWillEnterForeground:

(void)	- sceneDidEnterBackground:

Instance Methods inherited from <FlutterPluginRegistry>
(nonnull id< FlutterPluginRegistrar >)	- registrarForPlugin:

(nullable NSObject *)	- valuePublishedByPlugin:

Instance Methods inherited from <FlutterBinaryMessenger>
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:

(void)	- sendOnChannel:message:

(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:

Instance Methods inherited from <FlutterMouseCursorPluginDelegate>
(void)	- didUpdateMouseCursor:

Class Methods
(BOOL)	+ isProfilerEnabled `[implementation]`

(NSString *)	+ generateThreadLabel: `[implementation]`

(flutter::ThreadHost)	+ makeThreadHost: `[implementation]`

(static void)	+ SetEntryPoint `[implementation]`

(static void)	+ SetThreadPriority `[implementation]`

Protected Attributes
	: NSObject <FlutterTextureRegistry

	FlutterPluginRegistry

Properties
FlutterViewController *	viewController

FlutterMethodChannel *	localizationChannel

FlutterMethodChannel *	navigationChannel

FlutterMethodChannel *	restorationChannel

FlutterMethodChannel *	platformChannel

FlutterMethodChannel *	textInputChannel

FlutterBasicMessageChannel *	lifecycleChannel

FlutterBasicMessageChannel *	systemChannel

FlutterBasicMessageChannel *	settingsChannel

FlutterBasicMessageChannel *	keyEventChannel

NSURL *	vmServiceUrl

NSObject< FlutterBinaryMessenger > *	binaryMessenger

NSObject< FlutterTextureRegistry > *	textureRegistry

NSString *	isolateId

BOOL	isGpuDisabled

id< FlutterBinaryMessenger >	binaryMessenger

NSMutableDictionary *	pluginPublications `[implementation]`

NSMutableDictionary< NSString , FlutterEngineRegistrar > *	registrars `[implementation]`

NSString *	initialRoute `[implementation]`

id< NSObject >	flutterViewControllerWillDeallocObserver `[implementation]`

BOOL	enableEmbedderAPI `[implementation]`

NSMutableArray< NSNumber * > *	isResponseValid `[implementation]`

NSPointerArray *	pluginAppDelegates `[implementation]`

NSMutableDictionary< NSString , FlutterEngineRegistrar > *	pluginRegistrars `[implementation]`

FlutterRenderer *	renderer `[implementation]`

BOOL	semanticsEnabled `[implementation]`

FlutterPasteboard *	pasteboard `[implementation]`

FlutterEngineTerminationHandler *	terminationHandler `[implementation]`

Properties inherited from <FlutterUndoManagerDelegate>
Properties inherited from <FlutterViewEngineDelegate>

Detailed Description

The FlutterEngine class coordinates a single instance of execution for a FlutterDartProject. It may have zero or one FlutterViewController at a time, which can be specified via -setViewController:. FlutterViewController's initWithEngine initializer will automatically call -setViewController: for itself.

A FlutterEngine can be created independently of a FlutterViewController for headless execution. It can also persist across the lifespan of multiple FlutterViewController instances to maintain state and/or asynchronous tasks (such as downloading a large file).

A FlutterEngine can also be used to prewarm the Dart execution environment and reduce the latency of showing the Flutter screen when a FlutterViewController is created and presented. See http://flutter.dev/docs/development/add-to-app/performance for more details on loading performance.

Alternatively, you can simply create a new FlutterViewController with only a FlutterDartProject. That FlutterViewController will internally manage its own instance of a FlutterEngine, but will not guarantee survival of the engine beyond the life of the ViewController.

A newly initialized FlutterEngine will not actually run a Dart Isolate until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI is invoked. One of these methods must be invoked before calling -setViewController:.

Coordinates a single instance of execution of a Flutter engine.

A FlutterEngine can only be attached with one controller from the native code.

Definition at line 61 of file FlutterEngine.h.

Method Documentation

◆ activeTextInputView

- (UIView< UITextInput > *) activeTextInputView

implementation

Used to notify the active view when undo manager state (can redo/can undo) changes, in order to force keyboards to update undo/redo buttons.

Reimplemented from <FlutterUndoManagerDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                                            {
  return [[self textInputPlugin] textInputView];
}

◆ addInternalPlugins

- (void) addInternalPlugins

implementation

Definition at line 483 of file FlutterEngine.mm.

                           {
  __weak FlutterEngine* weakSelf = self;
  [FlutterMouseCursorPlugin registerWithRegistrar:[self registrarForPlugin:@"mousecursor"]
                                         delegate:self];
  [FlutterMenuPlugin registerWithRegistrar:[self registrarForPlugin:@"menu"]];
  _settingsChannel =
      [FlutterBasicMessageChannel messageChannelWithName:kFlutterSettingsChannel
                                         binaryMessenger:self.binaryMessenger
                                                   codec:[FlutterJSONMessageCodec sharedInstance]];
  _platformChannel =
      [FlutterMethodChannel methodChannelWithName:kFlutterPlatformChannel
                                  binaryMessenger:self.binaryMessenger
                                            codec:[FlutterJSONMethodCodec sharedInstance]];
  [_platformChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
    [weakSelf handleMethodCall:call result:result];
  }];
}

◆ addViewController:

- (void) addViewController: (FlutterViewController *) viewController

implementation

Attach a view controller to the engine as its default controller.

Since FlutterEngine can only handle the implicit view for now, the given controller will always be assigned to the implicit view, if there isn't an implicit view yet. If the engine already has an implicit view, this call throws an assertion.

The engine holds a weak reference to the attached view controller.

If the given view controller is already attached to an engine, this call throws an assertion.

Definition at line 483 of file FlutterEngine.mm.

                         :(FlutterViewController*)controller {
  // FlutterEngine can only handle the implicit view for now. Adding more views
  // throws an assertion.
  NSAssert(self.viewController == nil,
           @"The engine already has a view controller for the implicit view.");
  self.viewController = controller;
}

◆ announceAccessibilityMessage:withPriority:

- (void) announceAccessibilityMessage:	(NSString *)	message
withPriority:	(NSAccessibilityPriorityLevel)	priority

implementation

Announces accessibility messages.

Definition at line 483 of file FlutterEngine.mm.

                                    :(NSString*)message
                        withPriority:(NSAccessibilityPriorityLevel)priority {
  NSAccessibilityPostNotificationWithUserInfo(
      [self viewControllerForIdentifier:kFlutterImplicitViewId].flutterView,
      NSAccessibilityAnnouncementRequestedNotification,
      @{NSAccessibilityAnnouncementKey : message, NSAccessibilityPriorityKey : @(priority)});
}

◆ applicationDidEnterBackground:

- (void) applicationDidEnterBackground: (NSNotification*) notification

implementation

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                                     :(NSNotification*)notification {
  [self flutterDidEnterBackground:notification];
}

◆ applicationWillEnterForeground:

- (void) applicationWillEnterForeground: (NSNotification*) notification

implementation

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                                      :(NSNotification*)notification {
  [self flutterWillEnterForeground:notification];
}

◆ applicationWillTerminate:

- (void) applicationWillTerminate: (NSNotification*) notification

implementation

Definition at line 483 of file FlutterEngine.mm.

                                :(NSNotification*)notification {
  [self shutDownEngine];
}

◆ attachView

- (void) attachView

implementation

Definition at line 157 of file FlutterEngine.mm.

                   {
  self.iosPlatformView->attachView();
}

◆ cleanUpConnection:

- (void) cleanUpConnection: (FlutterBinaryMessengerConnection) connection

implementation

Clears out a channel's message handler if that handler is still the one that was created as a result of setMessageHandlerOnChannel:binaryMessageHandler:.

Parameters

connection The result from setMessageHandlerOnChannel:binaryMessageHandler:.

Reimplemented from <FlutterBinaryMessenger>.

Definition at line 822 of file FlutterEngine.mm.

                         :(FlutterBinaryMessengerConnection)connection {
  if (_shell && _shell->IsSetup()) {
    std::string channel = _connections->CleanupConnection(connection);
    if (!channel.empty()) {
      self.iosPlatformView->GetPlatformMessageHandlerIos()->SetMessageHandler(channel.c_str(), nil,
                                                                              nil);
    }
  }
}

◆ clipboardHasStrings

- (BOOL) clipboardHasStrings

implementation

Definition at line 483 of file FlutterEngine.mm.

                            {
  return [self.pasteboard stringForType:NSPasteboardTypeString].length > 0;
}

◆ createFlutterCompositor

- (FlutterCompositor *) createFlutterCompositor

implementation

Definition at line 483 of file FlutterEngine.mm.

                                              {
  _macOSCompositor = std::make_unique<flutter::FlutterCompositor>(
      [[FlutterViewEngineProvider alloc] initWithEngine:self],
      [[FlutterTimeConverter alloc] initWithEngine:self], _platformViewController);
 
  _compositor = {};
  _compositor.struct_size = sizeof(FlutterCompositor);
  _compositor.user_data = _macOSCompositor.get();
 
  _compositor.create_backing_store_callback = [](const FlutterBackingStoreConfig* config,  //
                                                 FlutterBackingStore* backing_store_out,   //
                                                 void* user_data                           //
                                              ) {
    return reinterpret_cast<flutter::FlutterCompositor*>(user_data)->CreateBackingStore(
        config, backing_store_out);
  };
 
  _compositor.collect_backing_store_callback = [](const FlutterBackingStore* backing_store,  //
                                                  void* user_data                            //
                                               ) { return true; };
 
  _compositor.present_view_callback = [](const FlutterPresentViewInfo* info) {
    return reinterpret_cast<flutter::FlutterCompositor*>(info->user_data)
        ->Present(info->view_id, info->layers, info->layers_count);
  };
 
  _compositor.avoid_backing_store_cache = true;
 
  return &_compositor;
}

◆ createShell:libraryURI:initialRoute:

- (BOOL) createShell:	(NSString*)	entrypoint
libraryURI:	(NSString*)	libraryURI
initialRoute:	(NSString*)	initialRoute

implementation

Definition at line 822 of file FlutterEngine.mm.

                   :(NSString*)entrypoint
         libraryURI:(NSString*)libraryURI
       initialRoute:(NSString*)initialRoute {
  if (_shell != nullptr) {
    FML_LOG(WARNING) << "This FlutterEngine was already invoked.";
    return NO;
  }
 
  self.initialRoute = initialRoute;
 
  auto settings = [_dartProject.get() settings];
  if (initialRoute != nil) {
    self.initialRoute = initialRoute;
  } else if (settings.route.empty() == false) {
    self.initialRoute = [NSString stringWithUTF8String:settings.route.c_str()];
  }
 
  FlutterView.forceSoftwareRendering = settings.enable_software_rendering;
 
  auto platformData = [_dartProject.get() defaultPlatformData];
 
  SetEntryPoint(&settings, entrypoint, libraryURI);
 
  NSString* threadLabel = [FlutterEngine generateThreadLabel:_labelPrefix];
  _threadHost = std::make_shared<flutter::ThreadHost>();
  *_threadHost = [FlutterEngine makeThreadHost:threadLabel];
 
  // Lambda captures by pointers to ObjC objects are fine here because the
  // create call is synchronous.
  flutter::Shell::CreateCallback<flutter::PlatformView> on_create_platform_view =
      [self](flutter::Shell& shell) {
        [self recreatePlatformViewController];
        return std::make_unique<flutter::PlatformViewIOS>(
            shell, self->_renderingApi, self->_platformViewsController, shell.GetTaskRunners(),
            shell.GetConcurrentWorkerTaskRunner(), shell.GetIsGpuDisabledSyncSwitch());
      };
 
  flutter::Shell::CreateCallback<flutter::Rasterizer> on_create_rasterizer =
      [](flutter::Shell& shell) { return std::make_unique<flutter::Rasterizer>(shell); };
 
  flutter::TaskRunners task_runners(threadLabel.UTF8String,                          // label
                                    fml::MessageLoop::GetCurrent().GetTaskRunner(),  // platform
                                    _threadHost->raster_thread->GetTaskRunner(),     // raster
                                    _threadHost->ui_thread->GetTaskRunner(),         // ui
                                    _threadHost->io_thread->GetTaskRunner()          // io
  );
 
#if APPLICATION_EXTENSION_API_ONLY
  if (@available(iOS 13.0, *)) {
    _isGpuDisabled = self.viewController.flutterWindowSceneIfViewLoaded.activationState ==
                     UISceneActivationStateBackground;
  } else {
    // [UIApplication sharedApplication API is not available for app extension.
    // We intialize the shell assuming the GPU is required.
    _isGpuDisabled = NO;
  }
#else
  _isGpuDisabled =
      [UIApplication sharedApplication].applicationState == UIApplicationStateBackground;
#endif
 
  // Create the shell. This is a blocking operation.
  std::unique_ptr<flutter::Shell> shell = flutter::Shell::Create(
      /*platform_data=*/platformData,
      /*task_runners=*/task_runners,
      /*settings=*/settings,
      /*on_create_platform_view=*/on_create_platform_view,
      /*on_create_rasterizer=*/on_create_rasterizer,
      /*is_gpu_disabled=*/_isGpuDisabled);
 
  if (shell == nullptr) {
    FML_LOG(ERROR) << "Could not start a shell FlutterEngine with entrypoint: "
                   << entrypoint.UTF8String;
  } else {
    // TODO(vashworth): Remove once done debugging https://github.com/flutter/flutter/issues/129836
    FML_LOG(INFO) << "Enabled VM Service Publication: " << settings.enable_vm_service_publication;
    [self setUpShell:std::move(shell)
        withVMServicePublication:settings.enable_vm_service_publication];
    if ([FlutterEngine isProfilerEnabled]) {
      [self startProfiler];
    }
  }
 
  return _shell != nullptr;
}

◆ dealloc

- (void) dealloc

implementation

Notify plugins of dealloc. This should happen first in dealloc since the plugins may be talking to things like the binaryMessenger.

nil out weak references.

Definition at line 157 of file FlutterEngine.mm.

                {
  /// Notify plugins of dealloc.  This should happen first in dealloc since the
  /// plugins may be talking to things like the binaryMessenger.
  [_pluginPublications enumerateKeysAndObjectsUsingBlock:^(id key, id object, BOOL* stop) {
    if ([object respondsToSelector:@selector(detachFromEngineForRegistrar:)]) {
      NSObject<FlutterPluginRegistrar>* registrar = self.registrars[key];
      [object detachFromEngineForRegistrar:registrar];
    }
  }];
 
  [[NSNotificationCenter defaultCenter] postNotificationName:kFlutterEngineWillDealloc
                                                      object:self
                                                    userInfo:nil];
 
  // It will be destroyed and invalidate its weak pointers
  // before any other members are destroyed.
  _weakFactory.reset();
 
  /// nil out weak references.
  [_registrars
      enumerateKeysAndObjectsUsingBlock:^(id key, FlutterEngineRegistrar* registrar, BOOL* stop) {
        registrar.flutterEngine = nil;
      }];
 
  [_labelPrefix release];
  [_initialRoute release];
  [_pluginPublications release];
  [_registrars release];
  _binaryMessenger.parent = nil;
  _textureRegistry.parent = nil;
  [_binaryMessenger release];
  [_textureRegistry release];
  _textureRegistry = nil;
  [_isolateId release];
 
  NSNotificationCenter* center = [NSNotificationCenter defaultCenter];
  if (_flutterViewControllerWillDeallocObserver) {
    [center removeObserver:_flutterViewControllerWillDeallocObserver];
    [_flutterViewControllerWillDeallocObserver release];
  }
  [center removeObserver:self];
 
  [super dealloc];
}

◆ deregisterViewControllerForIdentifier:

- (void) deregisterViewControllerForIdentifier: (FlutterViewIdentifier) viewIdentifier

implementation

An internal method that removes the view controller with the given ID.

This method clears the ID of the controller, removes the controller from the map. This is an no-op if the view ID is not associated with any view controllers.

Definition at line 483 of file FlutterEngine.mm.

                                             :(FlutterViewIdentifier)viewIdentifier {
  FlutterViewController* controller = [self viewControllerForIdentifier:viewIdentifier];
  // The controller can be nil. The engine stores only a weak ref, and this
  // method could have been called from the controller's dealloc.
  if (controller != nil) {
    [controller detachFromEngine];
    NSAssert(!controller.attached,
             @"The FlutterViewController unexpectedly stays attached after being removed. "
             @"In unit tests, this is likely because either the FlutterViewController or "
             @"the FlutterEngine is mocked. Please subclass these classes instead.");
  }
  [_viewControllers removeObjectForKey:@(viewIdentifier)];
  @synchronized(_vsyncWaiters) {
    [_vsyncWaiters removeObjectForKey:@(viewIdentifier)];
  }
}

◆ destroyContext

- (void) destroyContext

Destroy running context for an engine.

This method can be used to force the FlutterEngine object to release all resources. After sending this message, the object will be in an unusable state until it is deallocated. Accessing properties or sending messages to it will result in undefined behavior or runtime errors.

Definition at line 157 of file FlutterEngine.mm.

                       {
  [self resetChannels];
  self.isolateId = nil;
  _shell.reset();
  _profiler.reset();
  _threadHost.reset();
  _platformViewsController.reset();
}

◆ didUpdateMouseCursor:

- (void) didUpdateMouseCursor: (NSCursor*) cursor

implementation

Definition at line 483 of file FlutterEngine.mm.

                            :(NSCursor*)cursor {
  // Mouse cursor plugin does not specify which view is responsible for changing the cursor,
  // so the reasonable assumption here is that cursor change is a result of a mouse movement
  // and thus the cursor will be paired with last Flutter view that reveived mouse event.
  [_lastViewWithPointerEvent didUpdateMouseCursor:cursor];
}

◆ dispatchPointerDataPacket:

- (void) dispatchPointerDataPacket: (std::unique_ptr<flutter::PointerDataPacket>) packet

implementation

Definition at line 157 of file FlutterEngine.mm.

                                 :(std::unique_ptr<flutter::PointerDataPacket>)packet {
  if (!self.platformView) {
    return;
  }
  self.platformView->DispatchPointerDataPacket(std::move(packet));
}

◆ dispatchSemanticsAction:toTarget:withData:

- (void) dispatchSemanticsAction:	(FlutterSemanticsAction)	action
toTarget:	(uint16_t)	target
withData:	(fml::MallocMapping)	data

implementation

Dispatches semantics action back to the framework. The semantics must be enabled by calling the updateSemanticsEnabled before dispatching semantics actions.

Definition at line 483 of file FlutterEngine.mm.

                               :(FlutterSemanticsAction)action
                       toTarget:(uint16_t)target
                       withData:(fml::MallocMapping)data {
  _embedderAPI.DispatchSemanticsAction(_engine, target, action, data.GetMapping(), data.GetSize());
}

◆ embedderAPI

- (FlutterEngineProcTable &) embedderAPI

implementation

Function pointers for interacting with the embedder.h API.

Provided by category FlutterEngine(Test).

Definition at line 483 of file FlutterEngine.mm.

                                       {
  return _embedderAPI;
}

◆ engineCallbackOnPlatformMessage:

- (void) engineCallbackOnPlatformMessage: (const FlutterPlatformMessage *) message

implementation

Handles a platform message from the engine.

Definition at line 483 of file FlutterEngine.mm.

                                       :(const FlutterPlatformMessage*)message {
  NSData* messageData = nil;
  if (message->message_size > 0) {
    messageData = [NSData dataWithBytesNoCopy:(void*)message->message
                                       length:message->message_size
                                 freeWhenDone:NO];
  }
  NSString* channel = @(message->channel);
  __block const FlutterPlatformMessageResponseHandle* responseHandle = message->response_handle;
  __block FlutterEngine* weakSelf = self;
  NSMutableArray* isResponseValid = self.isResponseValid;
  FlutterEngineSendPlatformMessageResponseFnPtr sendPlatformMessageResponse =
      _embedderAPI.SendPlatformMessageResponse;
  FlutterBinaryReply binaryResponseHandler = ^(NSData* response) {
    @synchronized(isResponseValid) {
      if (![isResponseValid[0] boolValue]) {
        // Ignore, engine was killed.
        return;
      }
      if (responseHandle) {
        sendPlatformMessageResponse(weakSelf->_engine, responseHandle,
                                    static_cast<const uint8_t*>(response.bytes), response.length);
        responseHandle = NULL;
      } else {
        NSLog(@"Error: Message responses can be sent only once. Ignoring duplicate response "
               "on channel '%@'.",
              channel);
      }
    }
  };
 
  FlutterEngineHandlerInfo* handlerInfo = _messengerHandlers[channel];
  if (handlerInfo) {
    handlerInfo.handler(messageData, binaryResponseHandler);
  } else {
    binaryResponseHandler(nil);
  }
}

◆ engineCallbackOnPreEngineRestart

- (void) engineCallbackOnPreEngineRestart

implementation

Invoked right before the engine is restarted.

This should reset states to as if the application has just started. It usually indicates a hot restart (Shift-R in Flutter CLI.)

Definition at line 483 of file FlutterEngine.mm.

                                         {
  NSEnumerator* viewControllerEnumerator = [_viewControllers objectEnumerator];
  FlutterViewController* nextViewController;
  while ((nextViewController = [viewControllerEnumerator nextObject])) {
    [nextViewController onPreEngineRestart];
  }
}

◆ ensureSemanticsEnabled

- (void) ensureSemanticsEnabled

Ensures that Flutter will generate a semantics tree.

This is enabled by default if certain accessibility services are turned on by the user, or when using a Simulator. This method allows a user to turn semantics on when they would not ordinarily be generated and the performance overhead is not a concern, e.g. for UI testing. Note that semantics should never be programmatically turned off, as it would potentially disable accessibility services an end user has requested.

This method must only be called after launching the engine via -runWithEntrypoint: or -runWithEntryPoint:libraryURI.

Although this method returns synchronously, it does not guarantee that a semantics tree is actually available when the method returns. It synchronously ensures that the next frame the Flutter framework creates will have a semantics tree.

You can subscribe to semantics updates via NSNotificationCenter by adding an observer for the name FlutterSemanticsUpdateNotification. The object parameter will be the FlutterViewController associated with the semantics update. This will asynchronously fire after a semantics tree has actually built (which may be some time after the frame has been rendered).

Reimplemented in FlutterEngineSpy.

Definition at line 157 of file FlutterEngine.mm.

                               {
  self.iosPlatformView->SetSemanticsEnabled(true);
}

◆ executableName

- (nonnull NSString *) executableName

implementation

The executable name for the current process.

Definition at line 483 of file FlutterEngine.mm.

                                    {
  return [[[NSProcessInfo processInfo] arguments] firstObject] ?: @"Flutter";
}

◆ FLUTTER_DEPRECATED

- (NSURL *observatoryUrl) FLUTTER_DEPRECATED ("Use vmServiceUrl instead")

The depcreated NSURL of the Dart VM Service for the service isolate.

This is only set in debug and profile runtime modes, and only after the Dart VM Service is ready. In release mode or before the Dart VM Service has started, it returns nil.

◆ flutterDidEnterBackground:

- (void) flutterDidEnterBackground: (NSNotification*) notification

implementation

Definition at line 822 of file FlutterEngine.mm.

                                 :(NSNotification*)notification {
  [self setIsGpuDisabled:YES];
  [self notifyLowMemory];
}

◆ flutterTextInputPlugin:focusElement:atPoint:result:

- (void) flutterTextInputPlugin:	(FlutterTextInputPlugin*)	textInputPlugin
focusElement:	(UIScribbleElementIdentifier)	elementIdentifier
atPoint:	(CGPoint)	referencePoint
result:	(FlutterResult)	callback

implementation

Reimplemented from <FlutterIndirectScribbleDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                              :(FlutterTextInputPlugin*)textInputPlugin
                  focusElement:(UIScribbleElementIdentifier)elementIdentifier
                       atPoint:(CGPoint)referencePoint
                        result:(FlutterResult)callback {
  // TODO(justinmc): Switch from the TextInputClient to Scribble channel when
  // the framework has finished transitioning to the Scribble channel.
  // https://github.com/flutter/flutter/pull/115296
  [_textInputChannel.get()
      invokeMethod:@"TextInputClient.focusElement"
         arguments:@[ elementIdentifier, @(referencePoint.x), @(referencePoint.y) ]
            result:callback];
}

◆ flutterTextInputPlugin:requestElementsInRect:result:

- (void) flutterTextInputPlugin:	(FlutterTextInputPlugin*)	textInputPlugin
requestElementsInRect:	(CGRect)	rect
result:	(FlutterResult)	callback

implementation

Reimplemented from <FlutterIndirectScribbleDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                              :(FlutterTextInputPlugin*)textInputPlugin
         requestElementsInRect:(CGRect)rect
                        result:(FlutterResult)callback {
  // TODO(justinmc): Switch from the TextInputClient to Scribble channel when
  // the framework has finished transitioning to the Scribble channel.
  // https://github.com/flutter/flutter/pull/115296
  [_textInputChannel.get()
      invokeMethod:@"TextInputClient.requestElementsInRect"
         arguments:@[ @(rect.origin.x), @(rect.origin.y), @(rect.size.width), @(rect.size.height) ]
            result:callback];
}

◆ flutterTextInputView:didResignFirstResponderWithTextInputClient:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
didResignFirstResponderWithTextInputClient:	(int)	client

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
    didResignFirstResponderWithTextInputClient:(int)client {
  // When flutter text input view resign first responder, send a message to
  // framework to ensure the focus state is correct. This is useful when close
  // keyboard from platform side.
  [_textInputChannel.get() invokeMethod:@"TextInputClient.onConnectionClosed"
                              arguments:@[ @(client) ]];
 
  // Platform view's first responder detection logic:
  //
  // All text input widgets (e.g. EditableText) are backed by a dummy UITextInput view
  // in the TextInputPlugin. When this dummy UITextInput view resigns first responder,
  // check if any platform view becomes first responder. If any platform view becomes
  // first responder, send a "viewFocused" channel message to inform the framework to un-focus
  // the previously focused text input.
  //
  // Caveat:
  // 1. This detection logic does not cover the scenario when a platform view becomes
  // first responder without any flutter text input resigning its first responder status
  // (e.g. user tapping on platform view first). For now it works fine because the TextInputPlugin
  // does not track the focused platform view id (which is different from Android implementation).
  //
  // 2. This detection logic assumes that all text input widgets are backed by a dummy
  // UITextInput view in the TextInputPlugin, which may not hold true in the future.
 
  // Have to check in the next run loop, because iOS requests the previous first responder to
  // resign before requesting the next view to become first responder.
  dispatch_async(dispatch_get_main_queue(), ^(void) {
    long platform_view_id = self.platformViewsController->FindFirstResponderPlatformViewId();
    if (platform_view_id == -1) {
      return;
    }
 
    [_platformViewsChannel.get() invokeMethod:@"viewFocused" arguments:@(platform_view_id)];
  });
}

◆ flutterTextInputView:insertTextPlaceholderWithSize:withClient:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
insertTextPlaceholderWithSize:	(CGSize)	size
withClient:	(int)	client

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
    insertTextPlaceholderWithSize:(CGSize)size
                       withClient:(int)client {
  // TODO(justinmc): Switch from the TextInputClient to Scribble channel when
  // the framework has finished transitioning to the Scribble channel.
  // https://github.com/flutter/flutter/pull/115296
  [_textInputChannel.get() invokeMethod:@"TextInputClient.insertTextPlaceholder"
                              arguments:@[ @(client), @(size.width), @(size.height) ]];
}

◆ flutterTextInputView:performAction:withClient:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
performAction:	(FlutterTextInputAction)	action
withClient:	(int)	client

implementation

Reimplemented from <FlutterTextInputDelegate>.

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
               performAction:(FlutterTextInputAction)action
                  withClient:(int)client {
  NSString* actionString;
  switch (action) {
    case FlutterTextInputActionUnspecified:
      // Where did the term "unspecified" come from? iOS has a "default" and Android
      // has "unspecified." These 2 terms seem to mean the same thing but we need
      // to pick just one. "unspecified" was chosen because "default" is often a
      // reserved word in languages with switch statements (dart, java, etc).
      actionString = @"TextInputAction.unspecified";
      break;
    case FlutterTextInputActionDone:
      actionString = @"TextInputAction.done";
      break;
    case FlutterTextInputActionGo:
      actionString = @"TextInputAction.go";
      break;
    case FlutterTextInputActionSend:
      actionString = @"TextInputAction.send";
      break;
    case FlutterTextInputActionSearch:
      actionString = @"TextInputAction.search";
      break;
    case FlutterTextInputActionNext:
      actionString = @"TextInputAction.next";
      break;
    case FlutterTextInputActionContinue:
      actionString = @"TextInputAction.continueAction";
      break;
    case FlutterTextInputActionJoin:
      actionString = @"TextInputAction.join";
      break;
    case FlutterTextInputActionRoute:
      actionString = @"TextInputAction.route";
      break;
    case FlutterTextInputActionEmergencyCall:
      actionString = @"TextInputAction.emergencyCall";
      break;
    case FlutterTextInputActionNewline:
      actionString = @"TextInputAction.newline";
      break;
  }
  [_textInputChannel.get() invokeMethod:@"TextInputClient.performAction"
                              arguments:@[ @(client), actionString ]];
}

◆ flutterTextInputView:removeTextPlaceholder:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
removeTextPlaceholder:	(int)	client

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
       removeTextPlaceholder:(int)client {
  // TODO(justinmc): Switch from the TextInputClient to Scribble channel when
  // the framework has finished transitioning to the Scribble channel.
  // https://github.com/flutter/flutter/pull/115296
  [_textInputChannel.get() invokeMethod:@"TextInputClient.removeTextPlaceholder"
                              arguments:@[ @(client) ]];
}

◆ flutterTextInputView:showAutocorrectionPromptRectForStart:end:withClient:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
showAutocorrectionPromptRectForStart:	(NSUInteger)	start
end:	(NSUInteger)	end
withClient:	(int)	client

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
    showAutocorrectionPromptRectForStart:(NSUInteger)start
                                     end:(NSUInteger)end
                              withClient:(int)client {
  [_textInputChannel.get() invokeMethod:@"TextInputClient.showAutocorrectionPromptRect"
                              arguments:@[ @(client), @(start), @(end) ]];
}

◆ flutterTextInputView:showToolbar:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
showToolbar:	(int)	client

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView showToolbar:(int)client {
  // TODO(justinmc): Switch from the TextInputClient to Scribble channel when
  // the framework has finished transitioning to the Scribble channel.
  // https://github.com/flutter/flutter/pull/115296
  [_textInputChannel.get() invokeMethod:@"TextInputClient.showToolbar" arguments:@[ @(client) ]];
}

◆ flutterTextInputView:updateEditingClient:withDelta:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
updateEditingClient:	(int)	client
withDelta:	(NSDictionary*)	delta

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
         updateEditingClient:(int)client
                   withDelta:(NSDictionary*)delta {
  [_textInputChannel.get() invokeMethod:@"TextInputClient.updateEditingStateWithDeltas"
                              arguments:@[ @(client), delta ]];
}

◆ flutterTextInputView:updateEditingClient:withState:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
updateEditingClient:	(int)	client
withState:	(NSDictionary*)	state

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
         updateEditingClient:(int)client
                   withState:(NSDictionary*)state {
  [_textInputChannel.get() invokeMethod:@"TextInputClient.updateEditingState"
                              arguments:@[ @(client), state ]];
}

◆ flutterTextInputView:updateEditingClient:withState:withTag:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
updateEditingClient:	(int)	client
withState:	(NSDictionary*)	state
withTag:	(NSString*)	tag

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
         updateEditingClient:(int)client
                   withState:(NSDictionary*)state
                     withTag:(NSString*)tag {
  [_textInputChannel.get() invokeMethod:@"TextInputClient.updateEditingStateWithTag"
                              arguments:@[ @(client), @{tag : state} ]];
}

◆ flutterTextInputView:updateFloatingCursor:withClient:withPosition:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
updateFloatingCursor:	(FlutterFloatingCursorDragState)	state
withClient:	(int)	client
withPosition:	(NSDictionary*)	position

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
        updateFloatingCursor:(FlutterFloatingCursorDragState)state
                  withClient:(int)client
                withPosition:(NSDictionary*)position {
  NSString* stateString;
  switch (state) {
    case FlutterFloatingCursorDragStateStart:
      stateString = @"FloatingCursorDragState.start";
      break;
    case FlutterFloatingCursorDragStateUpdate:
      stateString = @"FloatingCursorDragState.update";
      break;
    case FlutterFloatingCursorDragStateEnd:
      stateString = @"FloatingCursorDragState.end";
      break;
  }
  [_textInputChannel.get() invokeMethod:@"TextInputClient.updateFloatingCursor"
                              arguments:@[ @(client), stateString, position ]];
}

◆ flutterTextInputView:willDismissEditMenuWithTextInputClient:

- (void) flutterTextInputView:	(FlutterTextInputView*)	textInputView
willDismissEditMenuWithTextInputClient:	(int)	client

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                            :(FlutterTextInputView*)textInputView
    willDismissEditMenuWithTextInputClient:(int)client {
  [_platformChannel.get() invokeMethod:@"ContextMenu.onDismissSystemContextMenu"
                             arguments:@[ @(client) ]];
}

◆ flutterTextInputViewScribbleInteractionBegan:

- (void) flutterTextInputViewScribbleInteractionBegan: (FlutterTextInputView*) textInputView

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                                                    :(FlutterTextInputView*)textInputView {
  // TODO(justinmc): Switch from the TextInputClient to Scribble channel when
  // the framework has finished transitioning to the Scribble channel.
  // https://github.com/flutter/flutter/pull/115296
  [_textInputChannel.get() invokeMethod:@"TextInputClient.scribbleInteractionBegan" arguments:nil];
}

◆ flutterTextInputViewScribbleInteractionFinished:

- (void) flutterTextInputViewScribbleInteractionFinished: (FlutterTextInputView*) textInputView

implementation

Reimplemented from <FlutterTextInputDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                                                       :(FlutterTextInputView*)textInputView {
  // TODO(justinmc): Switch from the TextInputClient to Scribble channel when
  // the framework has finished transitioning to the Scribble channel.
  // https://github.com/flutter/flutter/pull/115296
  [_textInputChannel.get() invokeMethod:@"TextInputClient.scribbleInteractionFinished"
                              arguments:nil];
}

◆ flutterViewAccessibilityDidCall

- (void) flutterViewAccessibilityDidCall

implementation

A callback that is called when iOS queries accessibility information of the Flutter view.

This is useful to predict the current iOS accessibility status. For example, there is no API to listen whether voice control is turned on or off. The Flutter engine uses this callback to enable semantics in order to catch the case that voice control is on.

Reimplemented from <FlutterViewEngineDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                                        {
  if (self.viewController.view.accessibilityElements == nil) {
    [self ensureSemanticsEnabled];
  }
}

◆ flutterWillEnterForeground:

- (void) flutterWillEnterForeground: (NSNotification*) notification

implementation

Definition at line 822 of file FlutterEngine.mm.

                                  :(NSNotification*)notification {
  [self setIsGpuDisabled:NO];
}

◆ generateThreadLabel:

+ (NSString *) generateThreadLabel: (NSString*) labelPrefix

implementation

Definition at line 157 of file FlutterEngine.mm.

                                :(NSString*)labelPrefix {
  static size_t s_shellCount = 0;
  return [NSString stringWithFormat:@"%@.%zu", labelPrefix, ++s_shellCount];
}

◆ getClipboardData:

- (NSDictionary *) getClipboardData: (NSString*) format

implementation

Definition at line 483 of file FlutterEngine.mm.

                                 :(NSString*)format {
  if ([format isEqualToString:@(kTextPlainFormat)]) {
    NSString* stringInPasteboard = [self.pasteboard stringForType:NSPasteboardTypeString];
    return stringInPasteboard == nil ? nil : @{@"text" : stringInPasteboard};
  }
  return nil;
}

◆ getWeakNSObject

- (WeakNSObject< FlutterEngine >) FlutterEngine:

implementation

Definition at line 157 of file FlutterEngine.mm.

                                                  {
  return _weakFactory->GetWeakNSObject();
}

◆ handleAccessibilityEvent:

- (void) handleAccessibilityEvent: (NSDictionary< NSString *, id > *) annotatedEvent

implementation

Handles accessibility events.

Definition at line 483 of file FlutterEngine.mm.

                                :(NSDictionary<NSString*, id>*)annotatedEvent {
  NSString* type = annotatedEvent[@"type"];
  if ([type isEqualToString:@"announce"]) {
    NSString* message = annotatedEvent[@"data"][@"message"];
    NSNumber* assertiveness = annotatedEvent[@"data"][@"assertiveness"];
    if (message == nil) {
      return;
    }
 
    NSAccessibilityPriorityLevel priority = [assertiveness isEqualToNumber:@1]
                                                ? NSAccessibilityPriorityHigh
                                                : NSAccessibilityPriorityMedium;
 
    [self announceAccessibilityMessage:message withPriority:priority];
  }
}

◆ handleDidChangeOcclusionState:

- (void) handleDidChangeOcclusionState: (NSNotification*) notification

implementation

Called when the |FlutterAppDelegate| gets the applicationDidUnhide notification.

Definition at line 483 of file FlutterEngine.mm.

                                     :(NSNotification*)notification {
  NSApplicationOcclusionState occlusionState = [[NSApplication sharedApplication] occlusionState];
  if (occlusionState & NSApplicationOcclusionStateVisible) {
    _visible = YES;
    if (_active) {
      [self setApplicationState:flutter::AppLifecycleState::kResumed];
    } else {
      [self setApplicationState:flutter::AppLifecycleState::kInactive];
    }
  } else {
    _visible = NO;
    [self setApplicationState:flutter::AppLifecycleState::kHidden];
  }
}

◆ handleMethodCall:result:

- (void) handleMethodCall:	(FlutterMethodCall *)	call
result:	(FlutterResult)	result

implementation

Handles messages received from the Flutter engine on the _*Channel channels.

Definition at line 483 of file FlutterEngine.mm.

                        :(FlutterMethodCall*)call result:(FlutterResult)result {
  if ([call.method isEqualToString:@"SystemNavigator.pop"]) {
    [[NSApplication sharedApplication] terminate:self];
    result(nil);
  } else if ([call.method isEqualToString:@"SystemSound.play"]) {
    [self playSystemSound:call.arguments];
    result(nil);
  } else if ([call.method isEqualToString:@"Clipboard.getData"]) {
    result([self getClipboardData:call.arguments]);
  } else if ([call.method isEqualToString:@"Clipboard.setData"]) {
    [self setClipboardData:call.arguments];
    result(nil);
  } else if ([call.method isEqualToString:@"Clipboard.hasStrings"]) {
    result(@{@"value" : @([self clipboardHasStrings])});
  } else if ([call.method isEqualToString:@"System.exitApplication"]) {
    if ([self terminationHandler] == nil) {
      // If the termination handler isn't set, then either we haven't
      // initialized it yet, or (more likely) the NSApp delegate isn't a
      // FlutterAppDelegate, so it can't cancel requests to exit. So, in that
      // case, just terminate when requested.
      [NSApp terminate:self];
      result(nil);
    } else {
      [[self terminationHandler] handleRequestAppExitMethodCall:call.arguments result:result];
    }
  } else if ([call.method isEqualToString:@"System.initializationComplete"]) {
    if ([self terminationHandler] != nil) {
      [self terminationHandler].acceptingRequests = YES;
    }
    result(nil);
  } else {
    result(FlutterMethodNotImplemented);
  }
}

◆ handleUndoWithDirection:

- (void) handleUndoWithDirection: (FlutterUndoRedoDirection) direction

implementation

Pass changes to the framework through the undo manager channel.

Reimplemented from <FlutterUndoManagerDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                               :(FlutterUndoRedoDirection)direction {
  NSString* action = (direction == FlutterUndoRedoDirectionUndo) ? @"undo" : @"redo";
  [_undoManagerChannel.get() invokeMethod:@"UndoManagerClient.handleUndo" arguments:@[ action ]];
}

◆ handleWillBecomeActive:

- (void) handleWillBecomeActive: (NSNotification*) notification

implementation

Called when the |FlutterAppDelegate| gets the applicationWillBecomeActive notification.

Definition at line 483 of file FlutterEngine.mm.

                              :(NSNotification*)notification {
  _active = YES;
  if (!_visible) {
    [self setApplicationState:flutter::AppLifecycleState::kHidden];
  } else {
    [self setApplicationState:flutter::AppLifecycleState::kResumed];
  }
}

◆ handleWillResignActive:

- (void) handleWillResignActive: (NSNotification*) notification

implementation

Called when the |FlutterAppDelegate| gets the applicationWillResignActive notification.

Definition at line 483 of file FlutterEngine.mm.

                              :(NSNotification*)notification {
  _active = NO;
  if (!_visible) {
    [self setApplicationState:flutter::AppLifecycleState::kHidden];
  } else {
    [self setApplicationState:flutter::AppLifecycleState::kInactive];
  }
}

◆ hasPlugin:

- (BOOL) hasPlugin: (NSString *) pluginKey

implementation

Returns whether the specified plugin has been registered.

Parameters

pluginKey The unique key identifying the plugin.

Returns: YES if registrarForPlugin has been called with pluginKey.

Reimplemented from <FlutterPluginRegistry>.

Definition at line 822 of file FlutterEngine.mm.

                 :(NSString*)pluginKey {
  return _pluginPublications[pluginKey] != nil;
}

◆ init

- (instancetype) init

Default initializer for a FlutterEngine.

Threads created by this FlutterEngine will appear as "FlutterEngine #" in Instruments. The prefix can be customized using initWithName.

The engine will execute the project located in the bundle with the identifier "io.flutter.flutter.app" (the default for Flutter projects).

A newly initialized engine will not run until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI: is called.

FlutterEngine created with this method will have allowHeadlessExecution set to YES. This means that the engine will continue to run regardless of whether a FlutterViewController is attached to it or not, until -destroyContext: is called or the process finishes.

Reimplemented in FlutterHeadlessDartRunner.

Definition at line 157 of file FlutterEngine.mm.

                     {
  return [self initWithName:@"FlutterEngine" project:nil allowHeadlessExecution:YES];
}

◆ initWithName:

- (instancetype) initWithName: (NSString*) labelPrefix

Initialize this FlutterEngine.

The engine will execute the project located in the bundle with the identifier "io.flutter.flutter.app" (the default for Flutter projects).

A newly initialized engine will not run until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI: is called.

FlutterEngine created with this method will have allowHeadlessExecution set to YES. This means that the engine will continue to run regardless of whether a FlutterViewController is attached to it or not, until -destroyContext: is called or the process finishes.

Parameters

labelPrefix The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances, and is used in instrumentation to label the threads used by this FlutterEngine.

Definition at line 157 of file FlutterEngine.mm.

                            :(NSString*)labelPrefix {
  return [self initWithName:labelPrefix project:nil allowHeadlessExecution:YES];
}

◆ initWithName:project: [1/3]

- (nonnull instancetype) initWithName:	(nonnull NSString *)	labelPrefix
project:	(nullable FlutterDartProject *)	project

Initializes an engine with the given project.

Parameters

labelPrefix	Currently unused; in the future, may be used for labelling threads as with the iOS FlutterEngine.
project	The project configuration. If nil, a default FlutterDartProject will be used.

◆ initWithName:project: [2/3]

- (instancetype) initWithName:	(NSString*)	labelPrefix
project:	(FlutterDartProject*)	project

implementation

Reimplemented in FlutterHeadlessDartRunner.

Definition at line 157 of file FlutterEngine.mm.

                            :(NSString*)labelPrefix project:(FlutterDartProject*)project {
  return [self initWithName:labelPrefix project:project allowHeadlessExecution:YES];
}

◆ initWithName:project: [3/3]

- (instancetype) initWithName:	(NSString *)	labelPrefix
project:	(nullable FlutterDartProject *)	project

Initialize this FlutterEngine with a FlutterDartProject.

If the FlutterDartProject is not specified, the FlutterEngine will attempt to locate the project in a default location (the flutter_assets folder in the iOS application bundle).

A newly initialized engine will not run the FlutterDartProject until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI: is called.

FlutterEngine created with this method will have allowHeadlessExecution set to YES. This means that the engine will continue to run regardless of whether a FlutterViewController is attached to it or not, until -destroyContext: is called or the process finishes.

Parameters

labelPrefix	The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances, and is used in instrumentation to label the threads used by this FlutterEngine.
project	The `FlutterDartProject` to run.

◆ initWithName:project:allowHeadlessExecution: [1/3]

- (nonnull instancetype) initWithName:	(nonnull NSString *)	labelPrefix
project:	(nullable FlutterDartProject *)	project
allowHeadlessExecution:	(BOOL)	NS_DESIGNATED_INITIALIZER

Initializes an engine that can run headlessly with the given project.

Parameters

labelPrefix	Currently unused; in the future, may be used for labelling threads as with the iOS FlutterEngine.
project	The project configuration. If nil, a default FlutterDartProject will be used.

◆ initWithName:project:allowHeadlessExecution: [2/3]

- (instancetype) initWithName:	(NSString*)	labelPrefix
project:	(FlutterDartProject*)	project
allowHeadlessExecution:	(BOOL)	allowHeadlessExecution

implementation

Reimplemented in FlutterHeadlessDartRunner.

Definition at line 157 of file FlutterEngine.mm.

                            :(NSString*)labelPrefix
                     project:(FlutterDartProject*)project
      allowHeadlessExecution:(BOOL)allowHeadlessExecution {
  return [self initWithName:labelPrefix
                     project:project
      allowHeadlessExecution:allowHeadlessExecution
          restorationEnabled:NO];
}

◆ initWithName:project:allowHeadlessExecution: [3/3]

- (instancetype) initWithName:	(NSString *)	labelPrefix
project:	(nullable FlutterDartProject *)	project
allowHeadlessExecution:	(BOOL)	allowHeadlessExecution

Initialize this FlutterEngine with a FlutterDartProject.

If the FlutterDartProject is not specified, the FlutterEngine will attempt to locate the project in a default location (the flutter_assets folder in the iOS application bundle).

A newly initialized engine will not run the FlutterDartProject until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI: is called.

Parameters

labelPrefix	The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances, and is used in instrumentation to label the threads used by this FlutterEngine.
project	The `FlutterDartProject` to run.
allowHeadlessExecution	Whether or not to allow this instance to continue running after passing a nil `FlutterViewController` to `-setViewController:`.

◆ initWithName:project:allowHeadlessExecution:restorationEnabled: [1/2]

- (instancetype) initWithName:	(NSString*)	labelPrefix
project:	(FlutterDartProject*)	project
allowHeadlessExecution:	(BOOL)	allowHeadlessExecution
restorationEnabled:	(BOOL)	restorationEnabled

implementation

Reimplemented in FlutterHeadlessDartRunner.

Definition at line 157 of file FlutterEngine.mm.

                            :(NSString*)labelPrefix
                     project:(FlutterDartProject*)project
      allowHeadlessExecution:(BOOL)allowHeadlessExecution
          restorationEnabled:(BOOL)restorationEnabled {
  self = [super init];
  NSAssert(self, @"Super init cannot be nil");
  NSAssert(labelPrefix, @"labelPrefix is required");
 
  _restorationEnabled = restorationEnabled;
  _allowHeadlessExecution = allowHeadlessExecution;
  _labelPrefix = [labelPrefix copy];
 
  _weakFactory = std::make_unique<fml::WeakNSObjectFactory<FlutterEngine>>(self);
 
  if (project == nil) {
    _dartProject.reset([[FlutterDartProject alloc] init]);
  } else {
    _dartProject.reset([project retain]);
  }
 
  _enableEmbedderAPI = _dartProject.get().settings.enable_embedder_api;
  if (_enableEmbedderAPI) {
    NSLog(@"============== iOS: enable_embedder_api is on ==============");
    _embedderAPI.struct_size = sizeof(FlutterEngineProcTable);
    FlutterEngineGetProcAddresses(&_embedderAPI);
  }
 
  if (!EnableTracingIfNecessary([_dartProject.get() settings])) {
    NSLog(
        @"Cannot create a FlutterEngine instance in debug mode without Flutter tooling or "
        @"Xcode.\n\nTo launch in debug mode in iOS 14+, run flutter run from Flutter tools, run "
        @"from an IDE with a Flutter IDE plugin or run the iOS project from Xcode.\nAlternatively "
        @"profile and release mode apps can be launched from the home screen.");
    [self release];
    return nil;
  }
 
  _pluginPublications = [[NSMutableDictionary alloc] init];
  _registrars = [[NSMutableDictionary alloc] init];
  [self recreatePlatformViewController];
 
  _binaryMessenger = [[FlutterBinaryMessengerRelay alloc] initWithParent:self];
  _textureRegistry = [[FlutterTextureRegistryRelay alloc] initWithParent:self];
  _connections.reset(new flutter::ConnectionCollection());
 
  NSNotificationCenter* center = [NSNotificationCenter defaultCenter];
  [center addObserver:self
             selector:@selector(onMemoryWarning:)
                 name:UIApplicationDidReceiveMemoryWarningNotification
               object:nil];
 
#if APPLICATION_EXTENSION_API_ONLY
  if (@available(iOS 13.0, *)) {
    [self setUpSceneLifecycleNotifications:center];
  } else {
    [self setUpApplicationLifecycleNotifications:center];
  }
#else
  [self setUpApplicationLifecycleNotifications:center];
#endif
 
  [center addObserver:self
             selector:@selector(onLocaleUpdated:)
                 name:NSCurrentLocaleDidChangeNotification
               object:nil];
 
  return self;
}

◆ initWithName:project:allowHeadlessExecution:restorationEnabled: [2/2]

- (instancetype) initWithName:	(NSString *)	labelPrefix
project:	(nullable FlutterDartProject *)	project
allowHeadlessExecution:	(BOOL)	allowHeadlessExecution
restorationEnabled:	(BOOL)	NS_DESIGNATED_INITIALIZER

Initialize this FlutterEngine with a FlutterDartProject.

If the FlutterDartProject is not specified, the FlutterEngine will attempt to locate the project in a default location (the flutter_assets folder in the iOS application bundle).

A newly initialized engine will not run the FlutterDartProject until either -runWithEntrypoint: or -runWithEntrypoint:libraryURI: is called.

Parameters

labelPrefix	The label prefix used to identify threads for this instance. Should be unique across FlutterEngine instances, and is used in instrumentation to label the threads used by this FlutterEngine.
project	The `FlutterDartProject` to run.
allowHeadlessExecution	Whether or not to allow this instance to continue running after passing a nil `FlutterViewController` to `-setViewController:`.
restorationEnabled	Whether state restoration is enabled. When true, the framework will wait for the attached view controller to provide restoration data.

◆ initWithScenario:withCompletion:

- (instancetype) initWithScenario:	(NSString*)	scenario
withCompletion:	(nullable void(^)(void))	engineRunCompletion

Provided by category FlutterEngine(ScenariosTest).

Definition at line 1 of file FlutterEngine+ScenariosTest.m.

                                :(NSString*)scenario
                  withCompletion:(nullable void (^)(void))engineRunCompletion {
  NSAssert([scenario length] != 0, @"You need to provide a scenario");
  self = [self initWithName:[NSString stringWithFormat:@"Test engine for %@", scenario]
                    project:nil];
  [self run];
 
  [self.binaryMessenger setMessageHandlerOnChannel:@"waiting_for_status"
                              binaryMessageHandler:^(NSData* message, FlutterBinaryReply reply) {
                                FlutterMethodChannel* channel = [FlutterMethodChannel
                                    methodChannelWithName:@"driver"
                                          binaryMessenger:self.binaryMessenger
                                                    codec:[FlutterJSONMethodCodec sharedInstance]];
                                [channel invokeMethod:@"set_scenario"
                                            arguments:@{@"name" : scenario}];
 
                                if (engineRunCompletion != nil) {
                                  engineRunCompletion();
                                }
                              }];
  return self;
}

◆ iosPlatformView

- (PlatformViewIOS *) FlutterEngine:

implementation

Definition at line 157 of file FlutterEngine.mm.

                                           {
  FML_DCHECK(_shell);
  return static_cast<flutter::PlatformViewIOS*>(_shell->GetPlatformView().get());
}

◆ isProfilerEnabled

+ (BOOL) isProfilerEnabled

implementation

Definition at line 157 of file FlutterEngine.mm.

                          {
  bool profilerEnabled = false;
#if (FLUTTER_RUNTIME_MODE == FLUTTER_RUNTIME_MODE_DEBUG) || \
    (FLUTTER_RUNTIME_MODE == FLUTTER_RUNTIME_MODE_PROFILE)
  profilerEnabled = true;
#endif
  return profilerEnabled;
}

◆ isUsingImpeller

- (BOOL) isUsingImpeller

implementation

Reimplemented from <FlutterViewEngineDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                        {
  return self.project.isImpellerEnabled;
}

◆ launchEngine:libraryURI:entrypointArgs:

- (void) launchEngine:	(NSString*)	entrypoint
libraryURI:	(NSString*)	libraryOrNil
entrypointArgs:	(NSArray<NSString>)	entrypointArgs

implementation

Definition at line 157 of file FlutterEngine.mm.

                    :(NSString*)entrypoint
          libraryURI:(NSString*)libraryOrNil
      entrypointArgs:(NSArray<NSString*>*)entrypointArgs {
  // Launch the Dart application with the inferred run configuration.
  self.shell.RunEngine([_dartProject.get() runConfigurationForEntrypoint:entrypoint
                                                            libraryOrNil:libraryOrNil
                                                          entrypointArgs:entrypointArgs]);
}

◆ loadAOTData:

- (void) loadAOTData: (NSString *) assetsDir

implementation

Loads the AOT snapshots and instructions from the elf bundle (app_elf_snapshot.so) into _aotData, if it is present in the assets directory.

Definition at line 483 of file FlutterEngine.mm.

                   :(NSString*)assetsDir {
  if (!_embedderAPI.RunsAOTCompiledDartCode()) {
    return;
  }
 
  BOOL isDirOut = false;  // required for NSFileManager fileExistsAtPath.
  NSFileManager* fileManager = [NSFileManager defaultManager];
 
  // This is the location where the test fixture places the snapshot file.
  // For applications built by Flutter tool, this is in "App.framework".
  NSString* elfPath = [NSString pathWithComponents:@[ assetsDir, @"app_elf_snapshot.so" ]];
 
  if (![fileManager fileExistsAtPath:elfPath isDirectory:&isDirOut]) {
    return;
  }
 
  FlutterEngineAOTDataSource source = {};
  source.type = kFlutterEngineAOTDataSourceTypeElfPath;
  source.elf_path = [elfPath cStringUsingEncoding:NSUTF8StringEncoding];
 
  auto result = _embedderAPI.CreateAOTData(&source, &_aotData);
  if (result != kSuccess) {
    NSLog(@"Failed to load AOT data from: %@", elfPath);
  }
}

◆ lookupKeyForAsset:

- (NSString *) lookupKeyForAsset: (NSString*) asset

implementation

Definition at line 822 of file FlutterEngine.mm.

                              :(NSString*)asset {
  return [FlutterDartProject lookupKeyForAsset:asset];
}

◆ lookupKeyForAsset:fromPackage:

- (NSString *) lookupKeyForAsset:	(NSString*)	asset
fromPackage:	(NSString*)	package

implementation

Definition at line 822 of file FlutterEngine.mm.

                              :(NSString*)asset fromPackage:(NSString*)package {
  return [FlutterDartProject lookupKeyForAsset:asset fromPackage:package];
}

◆ macOSCompositor

- (FlutterCompositor *) FlutterEngine:

implementation

The FlutterCompositor object currently in use by the FlutterEngine.

May be nil if the compositor has not been initialized yet.

Provided by category FlutterEngine(Test).

Definition at line 483 of file FlutterEngine.mm.

                                             {
  return _macOSCompositor.get();
}

◆ makeBackgroundTaskQueue

- (NSObject< FlutterTaskQueue > *) makeBackgroundTaskQueue

implementation

TODO(gaaclarke): Remove optional when macos supports Background Platform Channels.

Reimplemented from <FlutterBinaryMessenger>.

Definition at line 822 of file FlutterEngine.mm.

                                                       {
  return flutter::PlatformMessageHandlerIos::MakeBackgroundTaskQueue();
}

◆ makeThreadHost:

+ (ThreadHost) FlutterEngine: (NSString*) threadLabel

implementation

Definition at line 157 of file FlutterEngine.mm.

                                   :(NSString*)threadLabel {
  // The current thread will be used as the platform thread. Ensure that the message loop is
  // initialized.
  fml::MessageLoop::EnsureInitializedForCurrentThread();
 
  uint32_t threadHostType = flutter::ThreadHost::Type::kUi | flutter::ThreadHost::Type::kRaster |
                            flutter::ThreadHost::Type::kIo;
 
  if ([FlutterEngine isProfilerEnabled]) {
    threadHostType = threadHostType | flutter::ThreadHost::Type::kProfiler;
  }
 
  flutter::ThreadHost::ThreadHostConfig host_config(threadLabel.UTF8String, threadHostType,
                                                    IOSPlatformThreadConfigSetter);
 
  host_config.ui_config =
      fml::Thread::ThreadConfig(flutter::ThreadHost::ThreadHostConfig::MakeThreadName(
                                    flutter::ThreadHost::Type::kUi, threadLabel.UTF8String),
                                fml::Thread::ThreadPriority::kDisplay);
 
  host_config.raster_config =
      fml::Thread::ThreadConfig(flutter::ThreadHost::ThreadHostConfig::MakeThreadName(
                                    flutter::ThreadHost::Type::kRaster, threadLabel.UTF8String),
                                fml::Thread::ThreadPriority::kRaster);
 
  host_config.io_config =
      fml::Thread::ThreadConfig(flutter::ThreadHost::ThreadHostConfig::MakeThreadName(
                                    flutter::ThreadHost::Type::kIo, threadLabel.UTF8String),
                                fml::Thread::ThreadPriority::kNormal);
 
  return (flutter::ThreadHost){host_config};
}

◆ markTextureFrameAvailable:

- (BOOL) markTextureFrameAvailable: (int64_t) textureID

implementation

Marks texture with the given id as available. Returns YES on success.

Definition at line 483 of file FlutterEngine.mm.

                                 :(int64_t)textureID {
  return _embedderAPI.MarkExternalTextureFrameAvailable(_engine, textureID) == kSuccess;
}

◆ maybeSetupPlatformViewChannels

- (void) maybeSetupPlatformViewChannels

implementation

Definition at line 157 of file FlutterEngine.mm.

                                       {
  if (_shell && self.shell.IsSetup()) {
    FlutterPlatformPlugin* platformPlugin = _platformPlugin.get();
    [_platformChannel.get() setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
      [platformPlugin handleMethodCall:call result:result];
    }];
 
    fml::WeakNSObject<FlutterEngine> weakSelf = [self getWeakNSObject];
    [_platformViewsChannel.get()
        setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
          if (weakSelf) {
            weakSelf.get().platformViewsController->OnMethodCall(call, result);
          }
        }];
 
    FlutterTextInputPlugin* textInputPlugin = _textInputPlugin.get();
    [_textInputChannel.get() setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
      [textInputPlugin handleMethodCall:call result:result];
    }];
 
    FlutterUndoManagerPlugin* undoManagerPlugin = _undoManagerPlugin.get();
    [_undoManagerChannel.get()
        setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
          [undoManagerPlugin handleMethodCall:call result:result];
        }];
 
    FlutterSpellCheckPlugin* spellCheckPlugin = _spellCheckPlugin.get();
    [_spellCheckChannel.get()
        setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
          [spellCheckPlugin handleMethodCall:call result:result];
        }];
  }
}

◆ notifyLowMemory

- (void) notifyLowMemory

implementation

Reimplemented in FlutterEnginePartialMock.

Provided by category FlutterEngine(TestLowMemory).

Definition at line 822 of file FlutterEngine.mm.

                        {
  if (_shell) {
    _shell->NotifyLowMemoryWarning();
  }
  [_systemChannel sendMessage:@{@"type" : @"memoryPressure"}];
}

◆ notifyViewControllerDeallocated

- (void) notifyViewControllerDeallocated

implementation

Definition at line 157 of file FlutterEngine.mm.

                                        {
  [[self lifecycleChannel] sendMessage:@"AppLifecycleState.detached"];
  _textInputPlugin.get().viewController = nil;
  if (!_allowHeadlessExecution) {
    [self destroyContext];
  } else if (_shell) {
    flutter::PlatformViewIOS* platform_view = [self iosPlatformView];
    if (platform_view) {
      platform_view->SetOwnerViewController({});
    }
  }
  [_textInputPlugin.get() resetViewResponder];
  _viewController.reset();
}

◆ NS_UNAVAILABLE

- (nonnull instancetype) NS_UNAVAILABLE

◆ observatoryUrl

- (NSURL *) observatoryUrl

implementation

Definition at line 157 of file FlutterEngine.mm.

                         {
  return [_publisher.get() url];
}

◆ onAccessibilityStatusChanged:

- (void) onAccessibilityStatusChanged: (NSNotification*) notification

implementation

Definition at line 483 of file FlutterEngine.mm.

                                    :(NSNotification*)notification {
  BOOL enabled = [notification.userInfo[kEnhancedUserInterfaceKey] boolValue];
  NSEnumerator* viewControllerEnumerator = [_viewControllers objectEnumerator];
  FlutterViewController* nextViewController;
  while ((nextViewController = [viewControllerEnumerator nextObject])) {
    [nextViewController onAccessibilityStatusChanged:enabled];
  }
 
  self.semanticsEnabled = enabled;
}

◆ onLocaleUpdated:

- (void) onLocaleUpdated: (NSNotification*) notification

implementation

Definition at line 822 of file FlutterEngine.mm.

                       :(NSNotification*)notification {
  // Get and pass the user's preferred locale list to dart:ui.
  NSMutableArray<NSString*>* localeData = [[[NSMutableArray alloc] init] autorelease];
  NSArray<NSString*>* preferredLocales = [NSLocale preferredLanguages];
  for (NSString* localeID in preferredLocales) {
    NSLocale* locale = [[[NSLocale alloc] initWithLocaleIdentifier:localeID] autorelease];
    NSString* languageCode = [locale objectForKey:NSLocaleLanguageCode];
    NSString* countryCode = [locale objectForKey:NSLocaleCountryCode];
    NSString* scriptCode = [locale objectForKey:NSLocaleScriptCode];
    NSString* variantCode = [locale objectForKey:NSLocaleVariantCode];
    if (!languageCode) {
      continue;
    }
    [localeData addObject:languageCode];
    [localeData addObject:(countryCode ? countryCode : @"")];
    [localeData addObject:(scriptCode ? scriptCode : @"")];
    [localeData addObject:(variantCode ? variantCode : @"")];
  }
  if (localeData.count == 0) {
    return;
  }
  [self.localizationChannel invokeMethod:@"setLocale" arguments:localeData];
}

◆ onMemoryWarning:

- (void) onMemoryWarning: (NSNotification*) notification

implementation

Definition at line 822 of file FlutterEngine.mm.

                       :(NSNotification*)notification {
  [self notifyLowMemory];
}

◆ onSettingsChanged:

- (void) onSettingsChanged: (NSNotification*) notification

implementation

Definition at line 483 of file FlutterEngine.mm.

                         :(NSNotification*)notification {
  // TODO(jonahwilliams): https://github.com/flutter/flutter/issues/32015.
  NSString* brightness =
      [[NSUserDefaults standardUserDefaults] stringForKey:@"AppleInterfaceStyle"];
  [_settingsChannel sendMessage:@{
    @"platformBrightness" : [brightness isEqualToString:@"Dark"] ? @"dark" : @"light",
    // TODO(jonahwilliams): https://github.com/flutter/flutter/issues/32006.
    @"textScaleFactor" : @1.0,
    @"alwaysUse24HourFormat" : @false
  }];
}

◆ onVSync:

- (void) onVSync: (uintptr_t) baton

implementation

Definition at line 483 of file FlutterEngine.mm.

               :(uintptr_t)baton {
  @synchronized(_vsyncWaiters) {
    // TODO(knopp): Use vsync waiter for correct view.
    // https://github.com/flutter/flutter/issues/142845
    FlutterVSyncWaiter* waiter = [_vsyncWaiters objectForKey:@(kFlutterImplicitViewId)];
    [waiter waitForVSync:baton];
  }
}

◆ platformPlugin

- (FlutterPlatformPlugin *) platformPlugin

implementation

Definition at line 157 of file FlutterEngine.mm.

                                         {
  return _platformPlugin.get();
}

◆ platformTaskRunner

- (RefPtr<) fml:

implementation

Definition at line 157 of file FlutterEngine.mm.

                                               {
  FML_DCHECK(_shell);
  return _shell->GetTaskRunners().GetPlatformTaskRunner();
}

◆ platformView

- (WeakPtr<) flutter:

implementation

Definition at line 157 of file FlutterEngine.mm.

                                                {
  FML_DCHECK(_shell);
  return _shell->GetPlatformView();
}

◆ platformViewController

- (FlutterPlatformViewController *) platformViewController

implementation

Definition at line 483 of file FlutterEngine.mm.

                                                         {
  return _platformViewController;
}

◆ platformViewsController

- (shared_ptr<) flutter:

implementation

Reimplemented from <FlutterViewEngineDelegate>.

Definition at line 157 of file FlutterEngine.mm.

                                                                                 {
  return _platformViewsController;
}

◆ platformViewsRenderingAPI

- (IOSRenderingAPI) FlutterEngine:

implementation

Provided by category FlutterEngine(Test).

Definition at line 157 of file FlutterEngine.mm.

                                                    {
  return _renderingApi;
}

◆ playSystemSound:

- (void) playSystemSound: (NSString*) soundType

implementation

Definition at line 483 of file FlutterEngine.mm.

                       :(NSString*)soundType {
  if ([soundType isEqualToString:@"SystemSoundType.alert"]) {
    NSBeep();
  }
}

◆ pluginRegistry

- (id< FlutterPluginRegistry >) pluginRegistry

implementation

Definition at line 822 of file FlutterEngine.mm.

                                            {
  return self;
}

◆ postMainThreadTask:targetTimeInNanoseconds:

- (void) postMainThreadTask:	(FlutterTask)	task
targetTimeInNanoseconds:	(uint64_t)	targetTime

implementation

Requests that the task be posted back the to the Flutter engine at the target time. The target time is in the clock used by the Flutter engine.

Definition at line 483 of file FlutterEngine.mm.

                          :(FlutterTask)task targetTimeInNanoseconds:(uint64_t)targetTime {
  __weak FlutterEngine* weakSelf = self;
  auto worker = ^{
    [weakSelf runTaskOnEmbedder:task];
  };
 
  const auto engine_time = _embedderAPI.GetCurrentTime();
  if (targetTime <= engine_time) {
    dispatch_async(dispatch_get_main_queue(), worker);
 
  } else {
    dispatch_after(dispatch_time(DISPATCH_TIME_NOW, targetTime - engine_time),
                   dispatch_get_main_queue(), worker);
  }
}

◆ project

- (FlutterDartProject *) project

implementation

Definition at line 822 of file FlutterEngine.mm.

                               {
  return _dartProject.get();
}

◆ rasterTaskRunner

- (RefPtr<) fml:

implementation

Definition at line 157 of file FlutterEngine.mm.

                                             {
  FML_DCHECK(_shell);
  return _shell->GetTaskRunners().GetRasterTaskRunner();
}

◆ recreatePlatformViewController

- (void) recreatePlatformViewController

implementation

Definition at line 157 of file FlutterEngine.mm.

                                       {
  _renderingApi = flutter::GetRenderingAPIForProcess(FlutterView.forceSoftwareRendering);
  _platformViewsController.reset(new flutter::FlutterPlatformViewsController());
}

◆ registerTexture: [1/2]

- (int64_t) registerTexture: (id<FlutterTexture>) texture

implementation

Definition at line 483 of file FlutterEngine.mm.

                          :(id<FlutterTexture>)texture {
  return [_renderer registerTexture:texture];
}

◆ registerTexture: [2/2]

- (int64_t) registerTexture: (NSObject< FlutterTexture > *) texture

implementation

Registers a FlutterTexture for usage in Flutter and returns an id that can be used to reference that texture when calling into Flutter with channels. Textures must be registered on the platform thread. On success returns the pointer to the registered texture, else returns 0.

Reimplemented from <FlutterTextureRegistry>.

Definition at line 822 of file FlutterEngine.mm.

                          :(NSObject<FlutterTexture>*)texture {
  int64_t textureId = _nextTextureId++;
  self.iosPlatformView->RegisterExternalTexture(textureId, texture);
  return textureId;
}

◆ registerTextureWithID:

- (BOOL) registerTextureWithID: (int64_t) textureId

implementation

Registers an external texture with the given id. Returns YES on success.

Definition at line 483 of file FlutterEngine.mm.

                             :(int64_t)textureId {
  return _embedderAPI.RegisterExternalTexture(_engine, textureId) == kSuccess;
}

◆ registerViewController:forIdentifier:

- (void) registerViewController:	(FlutterViewController *)	controller
forIdentifier:	(FlutterViewIdentifier)	viewIdentifier

implementation

An internal method that adds the view controller with the given ID.

This method assigns the controller with the ID, puts the controller into the map, and does assertions related to the implicit view ID.

Definition at line 483 of file FlutterEngine.mm.

                              :(FlutterViewController*)controller
                 forIdentifier:(FlutterViewIdentifier)viewIdentifier {
  NSAssert(controller != nil, @"The controller must not be nil.");
  NSAssert(controller.engine == nil,
           @"The FlutterViewController is unexpectedly attached to "
           @"engine %@ before initialization.",
           controller.engine);
  NSAssert([_viewControllers objectForKey:@(viewIdentifier)] == nil,
           @"The requested view ID is occupied.");
  [_viewControllers setObject:controller forKey:@(viewIdentifier)];
  [controller setUpWithEngine:self
               viewIdentifier:viewIdentifier
           threadSynchronizer:_threadSynchronizer];
  NSAssert(controller.viewIdentifier == viewIdentifier, @"Failed to assign view ID.");
  // Verify that the controller's property are updated accordingly. Failing the
  // assertions is likely because either the FlutterViewController or the
  // FlutterEngine is mocked. Please subclass these classes instead.
  NSAssert(controller.attached, @"The FlutterViewController should switch to the attached mode "
                                @"after it is added to a FlutterEngine.");
  NSAssert(controller.engine == self,
           @"The FlutterViewController was added to %@, but its engine unexpectedly became %@.",
           self, controller.engine);
 
  if (controller.viewLoaded) {
    [self viewControllerViewDidLoad:controller];
  }
}

◆ registrarForPlugin:

- (id< FlutterPluginRegistrar >) registrarForPlugin: (NSString *) pluginKey

implementation

Returns a registrar for registering a plugin.

Parameters

pluginKey The unique key identifying the plugin.

Reimplemented from <FlutterPluginRegistry>.

Definition at line 822 of file FlutterEngine.mm.

                                                       :(NSString*)pluginKey {
  NSAssert(self.pluginPublications[pluginKey] == nil, @"Duplicate plugin key: %@", pluginKey);
  self.pluginPublications[pluginKey] = [NSNull null];
  FlutterEngineRegistrar* result = [[FlutterEngineRegistrar alloc] initWithPlugin:pluginKey
                                                                    flutterEngine:self];
  self.registrars[pluginKey] = result;
  return [result autorelease];
}

◆ removeViewController:

- (void) removeViewController: (nonnull FlutterViewController*) viewController

implementation

Definition at line 483 of file FlutterEngine.mm.

                            :(nonnull FlutterViewController*)viewController {
  [self deregisterViewControllerForIdentifier:viewController.viewIdentifier];
  [self shutDownIfNeeded];
}

◆ resetChannels

- (void) resetChannels

implementation

Definition at line 157 of file FlutterEngine.mm.

                      {
  _localizationChannel.reset();
  _navigationChannel.reset();
  _restorationChannel.reset();
  _platformChannel.reset();
  _platformViewsChannel.reset();
  _textInputChannel.reset();
  _undoManagerChannel.reset();
  _scribbleChannel.reset();
  _lifecycleChannel.reset();
  _systemChannel.reset();
  _settingsChannel.reset();
  _keyEventChannel.reset();
  _spellCheckChannel.reset();
}

◆ restorationPlugin

- (FlutterRestorationPlugin *) restorationPlugin

implementation

Definition at line 157 of file FlutterEngine.mm.

                                               {
  return _restorationPlugin.get();
}

◆ run

- (BOOL) run

Runs a Dart program on an Isolate from the main Dart library (i.e. the library that contains main()), using main() as the entrypoint (the default for Flutter projects), and using "/" (the default route) as the initial route.

The first call to this method will create a new Isolate. Subsequent calls will return immediately and have no effect.

Returns: YES if the call succeeds in creating and running a Flutter Engine instance; NO otherwise.

Definition at line 822 of file FlutterEngine.mm.

            {
  return [self runWithEntrypoint:FlutterDefaultDartEntrypoint
                      libraryURI:nil
                    initialRoute:FlutterDefaultInitialRoute];
}

◆ running

- (BOOL) running

implementation

True if the engine is currently running.

Definition at line 483 of file FlutterEngine.mm.

                {
  return _engine != nullptr;
}

◆ runTaskOnEmbedder:

- (void) runTaskOnEmbedder: (FlutterTask) task

implementation

Definition at line 483 of file FlutterEngine.mm.

                         :(FlutterTask)task {
  if (_engine) {
    auto result = _embedderAPI.RunTask(_engine, &task);
    if (result != kSuccess) {
      NSLog(@"Could not post a task to the Flutter engine.");
    }
  }
}

◆ runWithEntrypoint: [1/3]

- (BOOL) runWithEntrypoint: (NSString*) entrypoint

implementation

Definition at line 822 of file FlutterEngine.mm.

                         :(NSString*)entrypoint {
  return [self runWithEntrypoint:entrypoint libraryURI:nil initialRoute:FlutterDefaultInitialRoute];
}

◆ runWithEntrypoint: [2/3]

- (BOOL) runWithEntrypoint: (nullable NSString *) entrypoint

Runs a Dart program on an Isolate from the main Dart library (i.e. the library that contains main()), using "/" (the default route) as the initial route.

The first call to this method will create a new Isolate. Subsequent calls will return immediately and have no effect.

Parameters

entrypoint The name of a top-level function from the same Dart library that contains the app's main() function. If this is FlutterDefaultDartEntrypoint (or nil) it will default to main(). If it is not the app's main() function, that function must be decorated with @pragma(vm:entry-point) to ensure the method is not tree-shaken by the Dart compiler.

Returns: YES if the call succeeds in creating and running a Flutter Engine instance; NO otherwise.

◆ runWithEntrypoint: [3/3]

- (BOOL) runWithEntrypoint: (nullable NSString *) entrypoint

Runs a Dart program on an Isolate from the main Dart library (i.e. the library that contains main()).

The first call to this method will create a new Isolate. Subsequent calls will return immediately.

Parameters

entrypoint The name of a top-level function from the same Dart library that contains the app's main() function. If this is nil, it will default to main(). If it is not the app's main() function, that function must be decorated with @pragma(vm:entry-point) to ensure the method is not tree-shaken by the Dart compiler.

Returns: YES if the call succeeds in creating and running a Flutter Engine instance; NO otherwise.

◆ runWithEntrypoint:initialRoute: [1/2]

- (BOOL) runWithEntrypoint:	(NSString*)	entrypoint
initialRoute:	(NSString*)	initialRoute

implementation

Definition at line 822 of file FlutterEngine.mm.

                         :(NSString*)entrypoint initialRoute:(NSString*)initialRoute {
  return [self runWithEntrypoint:entrypoint libraryURI:nil initialRoute:initialRoute];
}

◆ runWithEntrypoint:initialRoute: [2/2]

- (BOOL) runWithEntrypoint:	(nullable NSString *)	entrypoint
initialRoute:	(nullable NSString *)	initialRoute

Runs a Dart program on an Isolate from the main Dart library (i.e. the library that contains main()).

The first call to this method will create a new Isolate. Subsequent calls will return immediately and have no effect.

Parameters

entrypoint	The name of a top-level function from the same Dart library that contains the app's main() function. If this is FlutterDefaultDartEntrypoint (or nil), it will default to `main()`. If it is not the app's main() function, that function must be decorated with `@pragma(vm:entry-point)` to ensure the method is not tree-shaken by the Dart compiler.
initialRoute	The name of the initial Flutter `Navigator` `Route` to load. If this is FlutterDefaultInitialRoute (or nil), it will default to the "/" route.

Returns: YES if the call succeeds in creating and running a Flutter Engine instance; NO otherwise.

◆ runWithEntrypoint:libraryURI: [1/2]

- (BOOL) runWithEntrypoint:	(NSString*)	entrypoint
libraryURI:	(NSString*)	libraryURI

implementation

Definition at line 822 of file FlutterEngine.mm.

                         :(NSString*)entrypoint libraryURI:(NSString*)libraryURI {
  return [self runWithEntrypoint:entrypoint
                      libraryURI:libraryURI
                    initialRoute:FlutterDefaultInitialRoute];
}

◆ runWithEntrypoint:libraryURI: [2/2]

- (BOOL) runWithEntrypoint:	(nullable NSString *)	entrypoint
libraryURI:	(nullable NSString *)	uri

Runs a Dart program on an Isolate using the specified entrypoint and Dart library, which may not be the same as the library containing the Dart program's main() function.

The first call to this method will create a new Isolate. Subsequent calls will return immediately and have no effect.

Parameters

entrypoint	The name of a top-level function from a Dart library. If this is FlutterDefaultDartEntrypoint (or nil); this will default to `main()`. If it is not the app's main() function, that function must be decorated with `@pragma(vm:entry-point)` to ensure the method is not tree-shaken by the Dart compiler.
uri	The URI of the Dart library which contains the entrypoint method (example "package:foo_package/main.dart"). If nil, this will default to the same library as the `main()` function in the Dart program.

Returns: YES if the call succeeds in creating and running a Flutter Engine instance; NO otherwise.

◆ runWithEntrypoint:libraryURI:initialRoute: [1/2]

- (BOOL) runWithEntrypoint:	(NSString*)	entrypoint
libraryURI:	(NSString*)	libraryURI
initialRoute:	(NSString*)	initialRoute

implementation

Definition at line 822 of file FlutterEngine.mm.

                         :(NSString*)entrypoint
               libraryURI:(NSString*)libraryURI
             initialRoute:(NSString*)initialRoute {
  return [self runWithEntrypoint:entrypoint
                      libraryURI:libraryURI
                    initialRoute:initialRoute
                  entrypointArgs:nil];
}

◆ runWithEntrypoint:libraryURI:initialRoute: [2/2]

- (BOOL) runWithEntrypoint:	(nullable NSString *)	entrypoint
libraryURI:	(nullable NSString *)	libraryURI
initialRoute:	(nullable NSString *)	initialRoute

Runs a Dart program on an Isolate using the specified entrypoint and Dart library, which may not be the same as the library containing the Dart program's main() function.

The first call to this method will create a new Isolate. Subsequent calls will return immediately and have no effect.

Parameters

entrypoint	The name of a top-level function from a Dart library. If this is FlutterDefaultDartEntrypoint (or nil); this will default to `main()`. If it is not the app's main() function, that function must be decorated with `@pragma(vm:entry-point)` to ensure the method is not tree-shaken by the Dart compiler.
libraryURI	The URI of the Dart library which contains the entrypoint method (example "package:foo_package/main.dart"). If nil, this will default to the same library as the `main()` function in the Dart program.
initialRoute	The name of the initial Flutter `Navigator` `Route` to load. If this is FlutterDefaultInitialRoute (or nil), it will default to the "/" route.

Returns: YES if the call succeeds in creating and running a Flutter Engine instance; NO otherwise.

◆ runWithEntrypoint:libraryURI:initialRoute:entrypointArgs: [1/2]

- (BOOL) runWithEntrypoint:	(NSString*)	entrypoint
libraryURI:	(NSString*)	libraryURI
initialRoute:	(NSString*)	initialRoute
entrypointArgs:	(NSArray<NSString>)	entrypointArgs

implementation

Definition at line 822 of file FlutterEngine.mm.

                         :(NSString*)entrypoint
               libraryURI:(NSString*)libraryURI
             initialRoute:(NSString*)initialRoute
           entrypointArgs:(NSArray<NSString*>*)entrypointArgs {
  if ([self createShell:entrypoint libraryURI:libraryURI initialRoute:initialRoute]) {
    [self launchEngine:entrypoint libraryURI:libraryURI entrypointArgs:entrypointArgs];
  }
 
  return _shell != nullptr;
}

◆ runWithEntrypoint:libraryURI:initialRoute:entrypointArgs: [2/2]

- (BOOL) runWithEntrypoint:	(nullable NSString *)	entrypoint
libraryURI:	(nullable NSString *)	libraryURI
initialRoute:	(nullable NSString *)	initialRoute
entrypointArgs:	(nullable NSArray< NSString * > *)	entrypointArgs

Runs a Dart program on an Isolate using the specified entrypoint and Dart library, which may not be the same as the library containing the Dart program's main() function.

The first call to this method will create a new Isolate. Subsequent calls will return immediately and have no effect.

Parameters

entrypoint	The name of a top-level function from a Dart library. If this is FlutterDefaultDartEntrypoint (or nil); this will default to `main()`. If it is not the app's main() function, that function must be decorated with `@pragma(vm:entry-point)` to ensure the method is not tree-shaken by the Dart compiler.
libraryURI	The URI of the Dart library which contains the entrypoint method (example "package:foo_package/main.dart"). If nil, this will default to the same library as the `main()` function in the Dart program.
initialRoute	The name of the initial Flutter `Navigator` `Route` to load. If this is FlutterDefaultInitialRoute (or nil), it will default to the "/" route.
entrypointArgs	Arguments passed as a list of string to Dart's entrypoint function.

Returns: YES if the call succeeds in creating and running a Flutter Engine instance; NO otherwise.

◆ sceneDidEnterBackground:

- (void) sceneDidEnterBackground: (ios(13.0)) API_AVAILABLE

Provided by category FlutterEngine(Test).

◆ sceneWillEnterForeground:

- (void) sceneWillEnterForeground: (ios(13.0)) API_AVAILABLE

Provided by category FlutterEngine(Test).

◆ screens

- (NSArray< NSScreen * > *) screens

implementation

Returns an array of screen objects representing all of the screens available on the system.

Reimplemented in MockableFlutterEngine.

Definition at line 483 of file FlutterEngine.mm.

                               {
  return [NSScreen screens];
}

◆ screenshot:base64Encode:

- Rasterizer:	(flutter::Rasterizer::ScreenshotType)	type
base64Encode:	(bool)	base64Encode

implementation

Definition at line 157 of file FlutterEngine.mm.

                                         :(flutter::Rasterizer::ScreenshotType)type
                                 base64Encode:(bool)base64Encode {
  return self.shell.Screenshot(type, base64Encode);
}

◆ scribbleChannel

- (FlutterMethodChannel *) scribbleChannel

implementation

Definition at line 157 of file FlutterEngine.mm.

                                         {
  return _scribbleChannel.get();
}

◆ sendInitialSettings

- (void) sendInitialSettings

implementation

Definition at line 483 of file FlutterEngine.mm.

                            {
  // TODO(jonahwilliams): https://github.com/flutter/flutter/issues/32015.
  [[NSDistributedNotificationCenter defaultCenter]
      addObserver:self
         selector:@selector(onSettingsChanged:)
             name:@"AppleInterfaceThemeChangedNotification"
           object:nil];
  [self onSettingsChanged:nil];
}

◆ sendKeyEvent:callback:userData: [1/2]

- (void) sendKeyEvent:	(const FlutterKeyEvent&)	event
callback:	(FlutterKeyEventCallback)	callback
userData:	(ios(13.4))	API_AVAILABLE

implementation

Definition at line 157 of file FlutterEngine.mm.

                    :(const FlutterKeyEvent&)event
            callback:(FlutterKeyEventCallback)callback
            userData:(void*)userData API_AVAILABLE(ios(13.4)) {
  if (@available(iOS 13.4, *)) {
  } else {
    return;
  }
  if (!self.platformView) {
    return;
  }
  const char* character = event.character;
 
  flutter::KeyData key_data;
  key_data.Clear();
  key_data.timestamp = (uint64_t)event.timestamp;
  switch (event.type) {
    case kFlutterKeyEventTypeUp:
      key_data.type = flutter::KeyEventType::kUp;
      break;
    case kFlutterKeyEventTypeDown:
      key_data.type = flutter::KeyEventType::kDown;
      break;
    case kFlutterKeyEventTypeRepeat:
      key_data.type = flutter::KeyEventType::kRepeat;
      break;
  }
  key_data.physical = event.physical;
  key_data.logical = event.logical;
  key_data.synthesized = event.synthesized;
 
  auto packet = std::make_unique<flutter::KeyDataPacket>(key_data, character);
  NSData* message = [NSData dataWithBytes:packet->data().data() length:packet->data().size()];
 
  auto response = ^(NSData* reply) {
    if (callback == nullptr) {
      return;
    }
    BOOL handled = FALSE;
    if (reply.length == 1 && *reinterpret_cast<const uint8_t*>(reply.bytes) == 1) {
      handled = TRUE;
    }
    callback(handled, userData);
  };
 
  [self sendOnChannel:kFlutterKeyDataChannel message:message binaryReply:response];
}

◆ sendKeyEvent:callback:userData: [2/2]

- (void) sendKeyEvent:	(const FlutterKeyEvent&)	event
callback:	(FlutterKeyEventCallback)	callback
userData:	(void*)	userData

implementation

Definition at line 483 of file FlutterEngine.mm.

                    :(const FlutterKeyEvent&)event
            callback:(FlutterKeyEventCallback)callback
            userData:(void*)userData {
  _embedderAPI.SendKeyEvent(_engine, &event, callback, userData);
}

◆ sendOnChannel:message: [1/2]

- (void) sendOnChannel:	(nonnull NSString*)	channel
message:	(nullable NSData*)	message

implementation

Definition at line 483 of file FlutterEngine.mm.

                     :(nonnull NSString*)channel message:(nullable NSData*)message {
  [self sendOnChannel:channel message:message binaryReply:nil];
}

◆ sendOnChannel:message: [2/2]

- (void) sendOnChannel:	(NSString*)	channel
message:	(NSData*)	message

implementation

Definition at line 822 of file FlutterEngine.mm.

                     :(NSString*)channel message:(NSData*)message {
  [self sendOnChannel:channel message:message binaryReply:nil];
}

◆ sendOnChannel:message:binaryReply: [1/2]

- (void) sendOnChannel:	(NSString *)	channel
message:	(NSData *_Nullable)	message
binaryReply:	(FlutterBinaryReply _Nullable)	callback

implementation

Sends a binary message to the Flutter side on the specified channel, expecting an asynchronous reply.

Parameters

channel	The channel name.
message	The message.
callback	A callback for receiving a reply.

Reimplemented from <FlutterBinaryMessenger>.

Definition at line 483 of file FlutterEngine.mm.

                     :(NSString*)channel
              message:(NSData* _Nullable)message
          binaryReply:(FlutterBinaryReply _Nullable)callback {
  FlutterPlatformMessageResponseHandle* response_handle = nullptr;
  if (callback) {
    struct Captures {
      FlutterBinaryReply reply;
    };
    auto captures = std::make_unique<Captures>();
    captures->reply = callback;
    auto message_reply = [](const uint8_t* data, size_t data_size, void* user_data) {
      auto captures = reinterpret_cast<Captures*>(user_data);
      NSData* reply_data = nil;
      if (data != nullptr && data_size > 0) {
        reply_data = [NSData dataWithBytes:static_cast<const void*>(data) length:data_size];
      }
      captures->reply(reply_data);
      delete captures;
    };
 
    FlutterEngineResult create_result = _embedderAPI.PlatformMessageCreateResponseHandle(
        _engine, message_reply, captures.get(), &response_handle);
    if (create_result != kSuccess) {
      NSLog(@"Failed to create a FlutterPlatformMessageResponseHandle (%d)", create_result);
      return;
    }
    captures.release();
  }
 
  FlutterPlatformMessage platformMessage = {
      .struct_size = sizeof(FlutterPlatformMessage),
      .channel = [channel UTF8String],
      .message = static_cast<const uint8_t*>(message.bytes),
      .message_size = message.length,
      .response_handle = response_handle,
  };
 
  FlutterEngineResult message_result = _embedderAPI.SendPlatformMessage(_engine, &platformMessage);
  if (message_result != kSuccess) {
    NSLog(@"Failed to send message to Flutter engine on channel '%@' (%d).", channel,
          message_result);
  }
 
  if (response_handle != nullptr) {
    FlutterEngineResult release_result =
        _embedderAPI.PlatformMessageReleaseResponseHandle(_engine, response_handle);
    if (release_result != kSuccess) {
      NSLog(@"Failed to release the response handle (%d).", release_result);
    };
  }
}

◆ sendOnChannel:message:binaryReply: [2/2]

- (void) sendOnChannel:	(NSString*)	channel
message:	(NSData*)	message
binaryReply:	(FlutterBinaryReply)	callback

implementation

Definition at line 822 of file FlutterEngine.mm.

                     :(NSString*)channel
              message:(NSData*)message
          binaryReply:(FlutterBinaryReply)callback {
  NSParameterAssert(channel);
  NSAssert(_shell && _shell->IsSetup(),
           @"Sending a message before the FlutterEngine has been run.");
  fml::RefPtr<flutter::PlatformMessageResponseDarwin> response =
      (callback == nil) ? nullptr
                        : fml::MakeRefCounted<flutter::PlatformMessageResponseDarwin>(
                              ^(NSData* reply) {
                                callback(reply);
                              },
                              _shell->GetTaskRunners().GetPlatformTaskRunner());
  std::unique_ptr<flutter::PlatformMessage> platformMessage =
      (message == nil) ? std::make_unique<flutter::PlatformMessage>(channel.UTF8String, response)
                       : std::make_unique<flutter::PlatformMessage>(
                             channel.UTF8String, flutter::CopyNSDataToMapping(message), response);
 
  _shell->GetPlatformView()->DispatchPlatformMessage(std::move(platformMessage));
  // platformMessage takes ownership of response.
  // NOLINTNEXTLINE(clang-analyzer-cplusplus.NewDeleteLeaks)
}

◆ sendPointerEvent:

- (void) sendPointerEvent: (const FlutterPointerEvent &) event

implementation

Dispatches the given pointer event data to engine.

Definition at line 483 of file FlutterEngine.mm.

                        :(const FlutterPointerEvent&)event {
  _embedderAPI.SendPointerEvent(_engine, &event, 1);
  _lastViewWithPointerEvent = [self viewControllerForIdentifier:kFlutterImplicitViewId].flutterView;
}

◆ sendUserLocales

- (void) sendUserLocales

implementation

Sends the list of user-preferred locales to the Flutter engine.

Definition at line 483 of file FlutterEngine.mm.

                        {
  if (!self.running) {
    return;
  }
 
  // Create a list of FlutterLocales corresponding to the preferred languages.
  NSMutableArray<NSLocale*>* locales = [NSMutableArray array];
  std::vector<FlutterLocale> flutterLocales;
  flutterLocales.reserve(locales.count);
  for (NSString* localeID in [NSLocale preferredLanguages]) {
    NSLocale* locale = [[NSLocale alloc] initWithLocaleIdentifier:localeID];
    [locales addObject:locale];
    flutterLocales.push_back(FlutterLocaleFromNSLocale(locale));
  }
  // Convert to a list of pointers, and send to the engine.
  std::vector<const FlutterLocale*> flutterLocaleList;
  flutterLocaleList.reserve(flutterLocales.size());
  std::transform(flutterLocales.begin(), flutterLocales.end(),
                 std::back_inserter(flutterLocaleList),
                 [](const auto& arg) -> const auto* { return &arg; });
  _embedderAPI.UpdateLocales(_engine, flutterLocaleList.data(), flutterLocaleList.size());
}

◆ setApplicationState:

- (void) setApplicationState: (flutter::AppLifecycleState) state

implementation

Handles changes to the application state, sending them to the framework.

Parameters

state One of the lifecycle constants in app_lifecycle_state.h, corresponding to the Dart enum AppLifecycleState.

Definition at line 483 of file FlutterEngine.mm.

                           :(flutter::AppLifecycleState)state {
  NSString* nextState =
      [[NSString alloc] initWithCString:flutter::AppLifecycleStateToString(state)];
  [self sendOnChannel:kFlutterLifecycleChannel
              message:[nextState dataUsingEncoding:NSUTF8StringEncoding]];
}

◆ setBinaryMessenger:

- (void) setBinaryMessenger: (FlutterBinaryMessengerRelay*) binaryMessenger

implementation

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                          :(FlutterBinaryMessengerRelay*)binaryMessenger {
  // Discard the previous messenger and keep the new one.
  if (binaryMessenger != _binaryMessenger) {
    _binaryMessenger.parent = nil;
    [_binaryMessenger release];
    _binaryMessenger = [binaryMessenger retain];
  }
}

◆ setClipboardData:

- (void) setClipboardData: (NSDictionary*) data

implementation

Definition at line 483 of file FlutterEngine.mm.

                        :(NSDictionary*)data {
  NSString* text = data[@"text"];
  [self.pasteboard clearContents];
  if (text && ![text isEqual:[NSNull null]]) {
    [self.pasteboard setString:text forType:NSPasteboardTypeString];
  }
}

◆ SetEntryPoint

+ (static void) SetEntryPoint	(flutter::Settings *)	settings
	(NSString *)	entrypoint
	(NSString *)	libraryURI

implementation

Definition at line 822 of file FlutterEngine.mm.

                                                                                                 {
  if (libraryURI) {
    FML_DCHECK(entrypoint) << "Must specify entrypoint if specifying library";
    settings->advisory_script_entrypoint = entrypoint.UTF8String;
    settings->advisory_script_uri = libraryURI.UTF8String;
  } else if (entrypoint) {
    settings->advisory_script_entrypoint = entrypoint.UTF8String;
    settings->advisory_script_uri = std::string("main.dart");
  } else {
    settings->advisory_script_entrypoint = std::string("main");
    settings->advisory_script_uri = std::string("main.dart");
  }
}

◆ setFlutterViewControllerWillDeallocObserver:

- (void) setFlutterViewControllerWillDeallocObserver: (id<NSObject>) observer

implementation

Definition at line 157 of file FlutterEngine.mm.

                                                   :(id<NSObject>)observer {
  if (observer != _flutterViewControllerWillDeallocObserver) {
    if (_flutterViewControllerWillDeallocObserver) {
      [[NSNotificationCenter defaultCenter]
          removeObserver:_flutterViewControllerWillDeallocObserver];
      [_flutterViewControllerWillDeallocObserver release];
    }
    _flutterViewControllerWillDeallocObserver = [observer retain];
  }
}

◆ setIsGpuDisabled:

- (void) setIsGpuDisabled: (BOOL) value

implementation

Definition at line 822 of file FlutterEngine.mm.

                        :(BOOL)value {
  if (_shell) {
    _shell->SetGpuAvailability(value ? flutter::GpuAvailability::kUnavailable
                                     : flutter::GpuAvailability::kAvailable);
  }
  _isGpuDisabled = value;
}

◆ setMessageHandlerOnChannel:binaryMessageHandler: [1/2]

- (FlutterBinaryMessengerConnection) setMessageHandlerOnChannel:	(nonnull NSString*)	channel
binaryMessageHandler:	(nullable FlutterBinaryMessageHandler)	handler

implementation

Definition at line 483 of file FlutterEngine.mm.

                                                              :(nonnull NSString*)channel
                                          binaryMessageHandler:
                                              (nullable FlutterBinaryMessageHandler)handler {
  _currentMessengerConnection += 1;
  _messengerHandlers[channel] =
      [[FlutterEngineHandlerInfo alloc] initWithConnection:@(_currentMessengerConnection)
                                                   handler:[handler copy]];
  return _currentMessengerConnection;
}

◆ setMessageHandlerOnChannel:binaryMessageHandler: [2/2]

- (FlutterBinaryMessengerConnection) setMessageHandlerOnChannel:	(NSString*)	channel
binaryMessageHandler:	(FlutterBinaryMessageHandler)	handler

implementation

Definition at line 822 of file FlutterEngine.mm.

                                                              :(NSString*)channel
                                          binaryMessageHandler:
                                              (FlutterBinaryMessageHandler)handler {
  return [self setMessageHandlerOnChannel:channel binaryMessageHandler:handler taskQueue:nil];
}

◆ setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:

- (FlutterBinaryMessengerConnection) setMessageHandlerOnChannel:	(NSString*)	channel
binaryMessageHandler:	(FlutterBinaryMessageHandler)	handler
taskQueue:	(NSObject<FlutterTaskQueue>* _Nullable)	taskQueue

implementation

Definition at line 822 of file FlutterEngine.mm.

                              :(NSString*)channel
          binaryMessageHandler:(FlutterBinaryMessageHandler)handler
                     taskQueue:(NSObject<FlutterTaskQueue>* _Nullable)taskQueue {
  NSParameterAssert(channel);
  if (_shell && _shell->IsSetup()) {
    self.iosPlatformView->GetPlatformMessageHandlerIos()->SetMessageHandler(channel.UTF8String,
                                                                            handler, taskQueue);
    return _connections->AquireConnection(channel.UTF8String);
  } else {
    NSAssert(!handler, @"Setting a message handler before the FlutterEngine has been run.");
    // Setting a handler to nil for a channel that has not yet been set up is a no-op.
    return flutter::ConnectionCollection::MakeErrorConnection(-1);
  }
}

◆ setSemanticsEnabled:

- (void) setSemanticsEnabled: (BOOL) enabled

implementation

Definition at line 483 of file FlutterEngine.mm.

                           :(BOOL)enabled {
  if (_semanticsEnabled == enabled) {
    return;
  }
  _semanticsEnabled = enabled;
 
  // Update all view controllers' bridges.
  NSEnumerator* viewControllerEnumerator = [_viewControllers objectEnumerator];
  FlutterViewController* nextViewController;
  while ((nextViewController = [viewControllerEnumerator nextObject])) {
    [nextViewController notifySemanticsEnabledChanged];
  }
 
  _embedderAPI.UpdateSemanticsEnabled(_engine, _semanticsEnabled);
}

◆ SetThreadPriority

+ (static void) SetThreadPriority (FlutterThreadPriority) priority

implementation

Definition at line 483 of file FlutterEngine.mm.

                                                              {
  if (priority == kDisplay || priority == kRaster) {
    pthread_t thread = pthread_self();
    sched_param param;
    int policy;
    if (!pthread_getschedparam(thread, &policy, &param)) {
      param.sched_priority = kMainThreadPriority;
      pthread_setschedparam(thread, policy, &param);
    }
    pthread_set_qos_class_self_np(QOS_CLASS_USER_INTERACTIVE, 0);
  }
}

◆ setUpAccessibilityChannel

- (void) setUpAccessibilityChannel

implementation

Creates an accessibility channel and sets up the message handler.

Definition at line 483 of file FlutterEngine.mm.

                                  {
  _accessibilityChannel = [FlutterBasicMessageChannel
      messageChannelWithName:@"flutter/accessibility"
             binaryMessenger:self.binaryMessenger
                       codec:[FlutterStandardMessageCodec sharedInstance]];
  __weak FlutterEngine* weakSelf = self;
  [_accessibilityChannel setMessageHandler:^(id message, FlutterReply reply) {
    [weakSelf handleAccessibilityEvent:message];
  }];
}

◆ setUpApplicationLifecycleNotifications:

- (void) setUpApplicationLifecycleNotifications: (NSNotificationCenter*) center

implementation

Definition at line 157 of file FlutterEngine.mm.

                                              :(NSNotificationCenter*)center {
  [center addObserver:self
             selector:@selector(applicationWillEnterForeground:)
                 name:UIApplicationWillEnterForegroundNotification
               object:nil];
  [center addObserver:self
             selector:@selector(applicationDidEnterBackground:)
                 name:UIApplicationDidEnterBackgroundNotification
               object:nil];
}

◆ setUpChannels

- (void) setUpChannels

implementation

Definition at line 157 of file FlutterEngine.mm.

                      {
  // This will be invoked once the shell is done setting up and the isolate ID
  // for the UI isolate is available.
  fml::WeakNSObject<FlutterEngine> weakSelf = [self getWeakNSObject];
  [_binaryMessenger setMessageHandlerOnChannel:@"flutter/isolate"
                          binaryMessageHandler:^(NSData* message, FlutterBinaryReply reply) {
                            if (weakSelf) {
                              weakSelf.get().isolateId =
                                  [[FlutterStringCodec sharedInstance] decode:message];
                            }
                          }];
 
  _localizationChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/localization"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMethodCodec sharedInstance]]);
 
  _navigationChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/navigation"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMethodCodec sharedInstance]]);
 
  if ([_initialRoute length] > 0) {
    // Flutter isn't ready to receive this method call yet but the channel buffer will cache this.
    [_navigationChannel invokeMethod:@"setInitialRoute" arguments:_initialRoute];
    [_initialRoute release];
    _initialRoute = nil;
  }
 
  _restorationChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/restoration"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterStandardMethodCodec sharedInstance]]);
 
  _platformChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/platform"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMethodCodec sharedInstance]]);
 
  _platformViewsChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/platform_views"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterStandardMethodCodec sharedInstance]]);
 
  _textInputChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/textinput"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMethodCodec sharedInstance]]);
 
  _undoManagerChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/undomanager"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMethodCodec sharedInstance]]);
 
  _scribbleChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/scribble"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMethodCodec sharedInstance]]);
 
  _spellCheckChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/spellcheck"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterStandardMethodCodec sharedInstance]]);
 
  _lifecycleChannel.reset([[FlutterBasicMessageChannel alloc]
         initWithName:@"flutter/lifecycle"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterStringCodec sharedInstance]]);
 
  _systemChannel.reset([[FlutterBasicMessageChannel alloc]
         initWithName:@"flutter/system"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMessageCodec sharedInstance]]);
 
  _settingsChannel.reset([[FlutterBasicMessageChannel alloc]
         initWithName:@"flutter/settings"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMessageCodec sharedInstance]]);
 
  _keyEventChannel.reset([[FlutterBasicMessageChannel alloc]
         initWithName:@"flutter/keyevent"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterJSONMessageCodec sharedInstance]]);
 
  FlutterTextInputPlugin* textInputPlugin = [[FlutterTextInputPlugin alloc] initWithDelegate:self];
  _textInputPlugin.reset(textInputPlugin);
  textInputPlugin.indirectScribbleDelegate = self;
  [textInputPlugin setUpIndirectScribbleInteraction:self.viewController];
 
  FlutterUndoManagerPlugin* undoManagerPlugin =
      [[FlutterUndoManagerPlugin alloc] initWithDelegate:self];
  _undoManagerPlugin.reset(undoManagerPlugin);
 
  _platformPlugin.reset([[FlutterPlatformPlugin alloc] initWithEngine:[self getWeakNSObject]]);
 
  _restorationPlugin.reset([[FlutterRestorationPlugin alloc]
         initWithChannel:_restorationChannel.get()
      restorationEnabled:_restorationEnabled]);
  _spellCheckPlugin.reset([[FlutterSpellCheckPlugin alloc] init]);
 
  _screenshotChannel.reset([[FlutterMethodChannel alloc]
         initWithName:@"flutter/screenshot"
      binaryMessenger:self.binaryMessenger
                codec:[FlutterStandardMethodCodec sharedInstance]]);
 
  [_screenshotChannel.get()
      setMethodCallHandler:^(FlutterMethodCall* _Nonnull call, FlutterResult _Nonnull result) {
        if (!(weakSelf.get() && weakSelf.get()->_shell && weakSelf.get()->_shell->IsSetup())) {
          return result([FlutterError
              errorWithCode:@"invalid_state"
                    message:@"Requesting screenshot while engine is not running."
                    details:nil]);
        }
        flutter::Rasterizer::Screenshot screenshot =
            [weakSelf.get() screenshot:flutter::Rasterizer::ScreenshotType::SurfaceData
                          base64Encode:NO];
        if (!screenshot.data) {
          return result([FlutterError errorWithCode:@"failure"
                                            message:@"Unable to get screenshot."
                                            details:nil]);
        }
        // TODO(gaaclarke): Find way to eliminate this data copy.
        NSData* data = [NSData dataWithBytes:screenshot.data->writable_data()
                                      length:screenshot.data->size()];
        NSString* format = [NSString stringWithUTF8String:screenshot.format.c_str()];
        NSNumber* width = @(screenshot.frame_size.fWidth);
        NSNumber* height = @(screenshot.frame_size.fHeight);
        return result(@[ width, height, format ?: [NSNull null], data ]);
      }];
}

◆ setUpNotificationCenterListeners

- (void) setUpNotificationCenterListeners

implementation

Definition at line 483 of file FlutterEngine.mm.

                                         {
  NSNotificationCenter* center = [NSNotificationCenter defaultCenter];
  // macOS fires this private message when VoiceOver turns on or off.
  [center addObserver:self
             selector:@selector(onAccessibilityStatusChanged:)
                 name:kEnhancedUserInterfaceNotification
               object:nil];
  [center addObserver:self
             selector:@selector(applicationWillTerminate:)
                 name:NSApplicationWillTerminateNotification
               object:nil];
  [center addObserver:self
             selector:@selector(windowDidChangeScreen:)
                 name:NSWindowDidChangeScreenNotification
               object:nil];
  [center addObserver:self
             selector:@selector(updateDisplayConfig:)
                 name:NSApplicationDidChangeScreenParametersNotification
               object:nil];
}

◆ setUpPlatformViewChannel

- (void) setUpPlatformViewChannel

implementation

Creates a platform view channel and sets up the method handler.

Definition at line 483 of file FlutterEngine.mm.

                                 {
  _platformViewsChannel =
      [FlutterMethodChannel methodChannelWithName:@"flutter/platform_views"
                                  binaryMessenger:self.binaryMessenger
                                            codec:[FlutterStandardMethodCodec sharedInstance]];
 
  __weak FlutterEngine* weakSelf = self;
  [_platformViewsChannel setMethodCallHandler:^(FlutterMethodCall* call, FlutterResult result) {
    [[weakSelf platformViewController] handleMethodCall:call result:result];
  }];
}

◆ setUpSceneLifecycleNotifications:

- (void) setUpSceneLifecycleNotifications: (ios(13.0)) API_AVAILABLE

implementation

Definition at line 157 of file FlutterEngine.mm.

                                        :(NSNotificationCenter*)center API_AVAILABLE(ios(13.0)) {
  [center addObserver:self
             selector:@selector(sceneWillEnterForeground:)
                 name:UISceneWillEnterForegroundNotification
               object:nil];
  [center addObserver:self
             selector:@selector(sceneDidEnterBackground:)
                 name:UISceneDidEnterBackgroundNotification
               object:nil];
}

◆ setUpShell:withVMServicePublication:

- (void) setUpShell:	(std::unique_ptr<flutter::Shell>)	shell
withVMServicePublication:	(BOOL)	doesVMServicePublication

implementation

Definition at line 157 of file FlutterEngine.mm.

                  :(std::unique_ptr<flutter::Shell>)shell
    withVMServicePublication:(BOOL)doesVMServicePublication {
  _shell = std::move(shell);
  [self setUpChannels];
  [self onLocaleUpdated:nil];
  [self updateDisplays];
  _publisher.reset([[FlutterDartVMServicePublisher alloc]
      initWithEnableVMServicePublication:doesVMServicePublication]);
  [self maybeSetupPlatformViewChannels];
  _shell->SetGpuAvailability(_isGpuDisabled ? flutter::GpuAvailability::kUnavailable
                                            : flutter::GpuAvailability::kAvailable);
}

◆ setViewController:

- (void) setViewController: (FlutterViewController*) viewController

implementation

Definition at line 157 of file FlutterEngine.mm.

                         :(FlutterViewController*)viewController {
  FML_DCHECK(self.iosPlatformView);
  _viewController = viewController ? [viewController getWeakNSObject]
                                   : fml::WeakNSObject<FlutterViewController>();
  self.iosPlatformView->SetOwnerViewController(_viewController);
  [self maybeSetupPlatformViewChannels];
  [self updateDisplays];
  _textInputPlugin.get().viewController = viewController;
 
  if (viewController) {
    __block FlutterEngine* blockSelf = self;
    self.flutterViewControllerWillDeallocObserver =
        [[NSNotificationCenter defaultCenter] addObserverForName:FlutterViewControllerWillDealloc
                                                          object:viewController
                                                           queue:[NSOperationQueue mainQueue]
                                                      usingBlock:^(NSNotification* note) {
                                                        [blockSelf notifyViewControllerDeallocated];
                                                      }];
  } else {
    self.flutterViewControllerWillDeallocObserver = nil;
    [self notifyLowMemory];
  }
}

◆ shell

- (Shell &) FlutterEngine:

implementation

Provided by category FlutterEngine(Test).

Definition at line 157 of file FlutterEngine.mm.

                       {
  FML_DCHECK(_shell);
  return *_shell;
}

◆ shutDownEngine

- (void) shutDownEngine

Shuts the Flutter engine if it is running. The FlutterEngine instance must always be shutdown before it may be collected. Not shutting down the FlutterEngine instance before releasing it will result in the leak of that engine instance.

Note: Called from dealloc. Should not use accessors or other methods.

Definition at line 483 of file FlutterEngine.mm.

                       {
  if (_engine == nullptr) {
    return;
  }
 
  [_threadSynchronizer shutdown];
  _threadSynchronizer = nil;
 
  FlutterEngineResult result = _embedderAPI.Deinitialize(_engine);
  if (result != kSuccess) {
    NSLog(@"Could not de-initialize the Flutter engine: error %d", result);
  }
 
  // Balancing release for the retain in the task runner dispatch table.
  CFRelease((CFTypeRef)self);
 
  result = _embedderAPI.Shutdown(_engine);
  if (result != kSuccess) {
    NSLog(@"Failed to shut down Flutter engine: error %d", result);
  }
  _engine = nullptr;
}

◆ shutDownIfNeeded

- (void) shutDownIfNeeded

implementation

Shuts down the engine if view requirement is not met, and headless execution is not allowed.

Definition at line 483 of file FlutterEngine.mm.

                         {
  if ([_viewControllers count] == 0 && !_allowHeadlessExecution) {
    [self shutDownEngine];
  }
}

◆ spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:

- (FlutterEngine *) spawnWithEntrypoint:	(/nullable/ NSString*)	entrypoint
libraryURI:	(/nullable/ NSString*)	libraryURI
initialRoute:	(/nullable/ NSString*)	initialRoute
entrypointArgs:	(/nullable/ NSArray<NSString>)	entrypointArgs

implementation

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                                     :(/*nullable*/ NSString*)entrypoint
                           libraryURI:(/*nullable*/ NSString*)libraryURI
                         initialRoute:(/*nullable*/ NSString*)initialRoute
                       entrypointArgs:(/*nullable*/ NSArray<NSString*>*)entrypointArgs {
  NSAssert(_shell, @"Spawning from an engine without a shell (possibly not run).");
  FlutterEngine* result = [[FlutterEngine alloc] initWithName:_labelPrefix
                                                      project:_dartProject.get()
                                       allowHeadlessExecution:_allowHeadlessExecution];
  flutter::RunConfiguration configuration =
      [_dartProject.get() runConfigurationForEntrypoint:entrypoint
                                           libraryOrNil:libraryURI
                                         entrypointArgs:entrypointArgs];
 
  fml::WeakPtr<flutter::PlatformView> platform_view = _shell->GetPlatformView();
  FML_DCHECK(platform_view);
  // Static-cast safe since this class always creates PlatformViewIOS instances.
  flutter::PlatformViewIOS* ios_platform_view =
      static_cast<flutter::PlatformViewIOS*>(platform_view.get());
  std::shared_ptr<flutter::IOSContext> context = ios_platform_view->GetIosContext();
  FML_DCHECK(context);
 
  // Lambda captures by pointers to ObjC objects are fine here because the
  // create call is synchronous.
  flutter::Shell::CreateCallback<flutter::PlatformView> on_create_platform_view =
      [result, context](flutter::Shell& shell) {
        [result recreatePlatformViewController];
        return std::make_unique<flutter::PlatformViewIOS>(
            shell, context, result->_platformViewsController, shell.GetTaskRunners());
      };
 
  flutter::Shell::CreateCallback<flutter::Rasterizer> on_create_rasterizer =
      [](flutter::Shell& shell) { return std::make_unique<flutter::Rasterizer>(shell); };
 
  std::string cppInitialRoute;
  if (initialRoute) {
    cppInitialRoute = [initialRoute UTF8String];
  }
 
  std::unique_ptr<flutter::Shell> shell = _shell->Spawn(
      std::move(configuration), cppInitialRoute, on_create_platform_view, on_create_rasterizer);
 
  result->_threadHost = _threadHost;
  result->_profiler = _profiler;
  result->_profiler_metrics = _profiler_metrics;
  result->_isGpuDisabled = _isGpuDisabled;
  [result setUpShell:std::move(shell) withVMServicePublication:NO];
  return [result autorelease];
}

◆ spellCheckChannel

- (FlutterMethodChannel *) spellCheckChannel

implementation

Definition at line 157 of file FlutterEngine.mm.

                                           {
  return _spellCheckChannel.get();
}

◆ startProfiler

- (void) startProfiler

implementation

Definition at line 157 of file FlutterEngine.mm.

                      {
  FML_DCHECK(!_threadHost->name_prefix.empty());
  _profiler_metrics = std::make_shared<flutter::ProfilerMetricsIOS>();
  _profiler = std::make_shared<flutter::SamplingProfiler>(
      _threadHost->name_prefix.c_str(), _threadHost->profiler_thread->GetTaskRunner(),
      [self]() { return self->_profiler_metrics->GenerateSample(); }, kNumProfilerSamplesPerSec);
  _profiler->Start();
}

◆ switches

- (vector<) std:

implementation

The command line arguments array for the engine.

Definition at line 483 of file FlutterEngine.mm.

                                 {
  return flutter::GetSwitchesFromEnvironment();
}

◆ takeScreenshot:asBase64Encoded:

- Rasterizer:	(flutter::Rasterizer::ScreenshotType)	type
asBase64Encoded:	(BOOL)	base64Encode

implementation

Reimplemented from <FlutterViewEngineDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                                             :(flutter::Rasterizer::ScreenshotType)type
                                  asBase64Encoded:(BOOL)base64Encode {
  FML_DCHECK(_shell) << "Cannot takeScreenshot without a shell";
  return _shell->Screenshot(type, base64Encode);
}

◆ testThreadSynchronizer

- (FlutterThreadSynchronizer *) testThreadSynchronizer

implementation

Provided by category FlutterEngine(Tests).

Definition at line 483 of file FlutterEngine.mm.

                                                     {
  return _threadSynchronizer;
}

◆ textInputPlugin

- (FlutterTextInputPlugin *) textInputPlugin

implementation

Reimplemented in FlutterEnginePartialMock.

Definition at line 157 of file FlutterEngine.mm.

                                           {
  return _textInputPlugin.get();
}

◆ textureFrameAvailable:

- (void) textureFrameAvailable: (int64_t) textureId

implementation

Notifies Flutter that the content of the previously registered texture has been updated.

This will trigger a call to -[FlutterTexture copyPixelBuffer] on the raster thread.

Reimplemented from <FlutterTextureRegistry>.

Definition at line 822 of file FlutterEngine.mm.

                             :(int64_t)textureId {
  _shell->GetPlatformView()->MarkTextureFrameAvailable(textureId);
}

◆ threadHost

- (const ThreadHost &) FlutterEngine:

implementation

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                                       {
  return *_threadHost;
}

◆ uiTaskRunner

- (RefPtr<) fml:

implementation

Definition at line 157 of file FlutterEngine.mm.

                                         {
  FML_DCHECK(_shell);
  return _shell->GetTaskRunners().GetUITaskRunner();
}

◆ undoManager

- (NSUndoManager *) undoManager

implementation

The NSUndoManager that should be managed by the FlutterUndoManagerPlugin. When the delegate is FlutterEngine this will be the FlutterViewController's undo manager.

Reimplemented from <FlutterUndoManagerDelegate>.

Definition at line 822 of file FlutterEngine.mm.

                              {
  return self.viewController.undoManager;
}

◆ undoManagerChannel

- (FlutterMethodChannel *) undoManagerChannel

implementation

Definition at line 157 of file FlutterEngine.mm.

                                            {
  return _undoManagerChannel.get();
}

◆ undoManagerPlugin

- (FlutterUndoManagerPlugin *) undoManagerPlugin

implementation

Definition at line 157 of file FlutterEngine.mm.

                                               {
  return _undoManagerPlugin.get();
}

◆ unregisterTexture:

- (void) unregisterTexture: (int64_t) textureId

implementation

Unregisters a FlutterTexture that has previously regeistered with registerTexture:. Textures must be unregistered on the platform thread.

Parameters

textureId The result that was previously returned from registerTexture:.

Reimplemented from <FlutterTextureRegistry>.

Definition at line 822 of file FlutterEngine.mm.

                         :(int64_t)textureId {
  _shell->GetPlatformView()->UnregisterTexture(textureId);
}

◆ unregisterTextureWithID:

- (BOOL) unregisterTextureWithID: (int64_t) textureID

implementation

Unregisters an external texture with the given id. Returns YES on success.

Definition at line 483 of file FlutterEngine.mm.

                               :(int64_t)textureID {
  return _embedderAPI.UnregisterExternalTexture(_engine, textureID) == kSuccess;
}

◆ updateDisplayConfig

- (void) updateDisplayConfig

implementation

Definition at line 483 of file FlutterEngine.mm.

                            {
  if (!_engine) {
    return;
  }
 
  std::vector<FlutterEngineDisplay> displays;
  for (NSScreen* screen : [self screens]) {
    CGDirectDisplayID displayID =
        static_cast<CGDirectDisplayID>([screen.deviceDescription[@"NSScreenNumber"] integerValue]);
 
    double devicePixelRatio = screen.backingScaleFactor;
    FlutterEngineDisplay display;
    display.struct_size = sizeof(display);
    display.display_id = displayID;
    display.single_display = false;
    display.width = static_cast<size_t>(screen.frame.size.width) * devicePixelRatio;
    display.height = static_cast<size_t>(screen.frame.size.height) * devicePixelRatio;
    display.device_pixel_ratio = devicePixelRatio;
 
    CVDisplayLinkRef displayLinkRef = nil;
    CVReturn error = CVDisplayLinkCreateWithCGDisplay(displayID, &displayLinkRef);
 
    if (error == 0) {
      CVTime nominal = CVDisplayLinkGetNominalOutputVideoRefreshPeriod(displayLinkRef);
      if (!(nominal.flags & kCVTimeIsIndefinite)) {
        double refreshRate = static_cast<double>(nominal.timeScale) / nominal.timeValue;
        display.refresh_rate = round(refreshRate);
      }
      CVDisplayLinkRelease(displayLinkRef);
    } else {
      display.refresh_rate = 0;
    }
 
    displays.push_back(display);
  }
  _embedderAPI.NotifyDisplayUpdate(_engine, kFlutterEngineDisplaysUpdateTypeStartup,
                                   displays.data(), displays.size());
}

◆ updateDisplayConfig:

- (void) updateDisplayConfig: (NSNotification*) notification

implementation

Definition at line 483 of file FlutterEngine.mm.

                           :(NSNotification*)notification {
  [self updateDisplayConfig];
}

◆ updateDisplays

- (void) updateDisplays

implementation

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                       {
  if (!_shell) {
    // Tests may do this.
    return;
  }
  auto vsync_waiter = _shell->GetVsyncWaiter().lock();
  auto vsync_waiter_ios = std::static_pointer_cast<flutter::VsyncWaiterIOS>(vsync_waiter);
  std::vector<std::unique_ptr<flutter::Display>> displays;
  auto screen_size = UIScreen.mainScreen.nativeBounds.size;
  auto scale = UIScreen.mainScreen.scale;
  displays.push_back(std::make_unique<flutter::VariableRefreshRateDisplay>(
      0, vsync_waiter_ios, screen_size.width, screen_size.height, scale));
  _shell->OnDisplayUpdates(std::move(displays));
}

◆ updateViewportMetrics:

- (void) updateViewportMetrics: (flutter::ViewportMetrics) viewportMetrics

implementation

Definition at line 157 of file FlutterEngine.mm.

                             :(flutter::ViewportMetrics)viewportMetrics {
  if (!self.platformView) {
    return;
  }
  self.platformView->SetViewportMetrics(flutter::kFlutterImplicitViewId, viewportMetrics);
}

◆ updateWindowMetricsForViewController:

- (void) updateWindowMetricsForViewController: (FlutterViewController *) viewController

implementation

Informs the engine that the specified view controller's window metrics have changed.

Definition at line 483 of file FlutterEngine.mm.

                                            :(FlutterViewController*)viewController {
  if (!_engine || !viewController || !viewController.viewLoaded) {
    return;
  }
  NSAssert([self viewControllerForIdentifier:viewController.viewIdentifier] == viewController,
           @"The provided view controller is not attached to this engine.");
  NSView* view = viewController.flutterView;
  CGRect scaledBounds = [view convertRectToBacking:view.bounds];
  CGSize scaledSize = scaledBounds.size;
  double pixelRatio = view.bounds.size.width == 0 ? 1 : scaledSize.width / view.bounds.size.width;
  auto displayId = [view.window.screen.deviceDescription[@"NSScreenNumber"] integerValue];
  const FlutterWindowMetricsEvent windowMetricsEvent = {
      .struct_size = sizeof(windowMetricsEvent),
      .width = static_cast<size_t>(scaledSize.width),
      .height = static_cast<size_t>(scaledSize.height),
      .pixel_ratio = pixelRatio,
      .left = static_cast<size_t>(scaledBounds.origin.x),
      .top = static_cast<size_t>(scaledBounds.origin.y),
      .display_id = static_cast<uint64_t>(displayId),
      .view_id = viewController.viewIdentifier,
  };
  _embedderAPI.SendWindowMetricsEvent(_engine, &windowMetricsEvent);
}

◆ valuePublishedByPlugin:

- (nullable NSObject *) valuePublishedByPlugin: (NSString *) pluginKey

implementation

Returns a value published by the specified plugin.

Parameters

pluginKey The unique key identifying the plugin.

Returns: An object published by the plugin, if any. Will be NSNull if nothing has been published. Will be nil if the plugin has not been registered.

Reimplemented from <FlutterPluginRegistry>.

Definition at line 822 of file FlutterEngine.mm.

                                   :(NSString*)pluginKey {
  return _pluginPublications[pluginKey];
}

◆ viewControllerForIdentifier:

- (FlutterViewController *) viewControllerForIdentifier: (FlutterViewIdentifier) viewIdentifier

implementation

Definition at line 483 of file FlutterEngine.mm.

                                                     :(FlutterViewIdentifier)viewIdentifier {
  FlutterViewController* controller = [_viewControllers objectForKey:@(viewIdentifier)];
  NSAssert(controller == nil || controller.viewIdentifier == viewIdentifier,
           @"The stored controller has unexpected view ID.");
  return controller;
}

◆ viewControllerViewDidLoad:

- (void) viewControllerViewDidLoad: (FlutterViewController *) viewController

implementation

Notify the engine that a view for the given view controller has been loaded.

Definition at line 483 of file FlutterEngine.mm.

                                 :(FlutterViewController*)viewController {
  __weak FlutterEngine* weakSelf = self;
  FlutterTimeConverter* timeConverter = [[FlutterTimeConverter alloc] initWithEngine:self];
  FlutterVSyncWaiter* waiter = [[FlutterVSyncWaiter alloc]
      initWithDisplayLink:[FlutterDisplayLink displayLinkWithView:viewController.view]
                    block:^(CFTimeInterval timestamp, CFTimeInterval targetTimestamp,
                            uintptr_t baton) {
                      uint64_t timeNanos = [timeConverter CAMediaTimeToEngineTime:timestamp];
                      uint64_t targetTimeNanos =
                          [timeConverter CAMediaTimeToEngineTime:targetTimestamp];
                      FlutterEngine* engine = weakSelf;
                      if (engine) {
                        // It is a bit unfortunate that embedder requires OnVSync call on
                        // platform thread just to immediately redispatch it to UI thread.
                        // We are already on UI thread right now, but have to do the
                        // extra hop to main thread.
                        [engine->_threadSynchronizer performOnPlatformThread:^{
                          engine->_embedderAPI.OnVsync(_engine, baton, timeNanos, targetTimeNanos);
                        }];
                      }
                    }];
  FML_DCHECK([_vsyncWaiters objectForKey:@(viewController.viewIdentifier)] == nil);
  @synchronized(_vsyncWaiters) {
    [_vsyncWaiters setObject:waiter forKey:@(viewController.viewIdentifier)];
  }
}

◆ waitForFirstFrame:callback:

- (void) waitForFirstFrame:	(NSTimeInterval)	timeout
callback:	(void(^_Nonnull)(BOOL didTimeout))	callback

implementation

Provided by category FlutterEngine(Test).

Definition at line 822 of file FlutterEngine.mm.

                         :(NSTimeInterval)timeout
                 callback:(void (^_Nonnull)(BOOL didTimeout))callback {
  dispatch_queue_t queue = dispatch_get_global_queue(QOS_CLASS_BACKGROUND, 0);
  dispatch_async(queue, ^{
    fml::TimeDelta waitTime = fml::TimeDelta::FromMilliseconds(timeout * 1000);
    BOOL didTimeout =
        self.shell.WaitForFirstFrame(waitTime).code() == fml::StatusCode::kDeadlineExceeded;
    dispatch_async(dispatch_get_main_queue(), ^{
      callback(didTimeout);
    });
  });
}

◆ windowDidChangeScreen:

- (void) windowDidChangeScreen: (NSNotification*) notification

implementation

Definition at line 483 of file FlutterEngine.mm.

                             :(NSNotification*)notification {
  // Update window metric for all view controllers since the display_id has
  // changed.
  NSEnumerator* viewControllerEnumerator = [_viewControllers objectEnumerator];
  FlutterViewController* nextViewController;
  while ((nextViewController = [viewControllerEnumerator nextObject])) {
    [self updateWindowMetricsForViewController:nextViewController];
  }
}

Member Data Documentation

◆ pad0

- __pad0__

protected

Definition at line 29 of file FlutterEngine.h.

◆ FlutterPluginRegistry

- FlutterPluginRegistry

protected

Definition at line 31 of file FlutterEngine.h.

Property Documentation

◆ binaryMessenger [1/2]

- (id< FlutterBinaryMessenger >) binaryMessenger

readnonatomicassign

The FlutterBinaryMessenger associated with this FlutterEngine (used for communicating with channels).

Definition at line 437 of file FlutterEngine.h.

◆ binaryMessenger [2/2]

- (id<FlutterBinaryMessenger>) binaryMessenger

readnonatomicassign

The FlutterBinaryMessenger for communicating with this engine.

Definition at line 91 of file FlutterEngine.h.

◆ enableEmbedderAPI

- (BOOL) enableEmbedderAPI

readwritenonatomicassignimplementation

Provided by category FlutterEngine(Test).

Definition at line 110 of file FlutterEngine.mm.

◆ flutterViewControllerWillDeallocObserver

- (id<NSObject>) flutterViewControllerWillDeallocObserver

readwritenonatomicretainimplementation

Provided by category FlutterEngine().

Definition at line 106 of file FlutterEngine.mm.

◆ initialRoute

- (NSString*) initialRoute

readwritenonatomiccopyimplementation

Provided by category FlutterEngine().

Definition at line 105 of file FlutterEngine.mm.

◆ isGpuDisabled

- (BOOL) isGpuDisabled

readwritenonatomicassign

Whether or not GPU calls are allowed.

Typically this is set when the app is backgrounded and foregrounded.

Definition at line 456 of file FlutterEngine.h.

◆ isolateId

- (NSString*) isolateId

readnonatomiccopy

The UI Isolate ID of the engine.

This property will be nil if the engine is not running.

Definition at line 449 of file FlutterEngine.h.

◆ isResponseValid

- (NSMutableArray<NSNumber*>*) isResponseValid

readwritenonatomicstrongimplementation

A mutable array that holds one bool value that determines if responses to platform messages are clear to execute. This value should be read or written only inside of a synchronized block and will return NO after the FlutterEngine has been dealloc'd.

Provided by category FlutterEngine().

Definition at line 99 of file FlutterEngine.mm.

◆ keyEventChannel

- (FlutterBasicMessageChannel *) keyEventChannel

readnonatomicassign

The FlutterBasicMessageChannel used for communicating key events from physical keyboards

Can be nil after destroyContext is called.

Definition at line 412 of file FlutterEngine.h.

◆ lifecycleChannel

- (FlutterBasicMessageChannel *) lifecycleChannel

readnonatomicassign

The FlutterBasicMessageChannel used to communicate app lifecycle events to the Dart Isolate.

Can be nil after destroyContext is called.

See also: Lifecycle Channel

Definition at line 385 of file FlutterEngine.h.

◆ localizationChannel

- (FlutterMethodChannel *) localizationChannel

readnonatomicassign

The FlutterMethodChannel used for localization related platform messages, such as setting the locale.

Can be nil after destroyContext is called.

Definition at line 335 of file FlutterEngine.h.

◆ navigationChannel

- (FlutterMethodChannel *) navigationChannel

readnonatomicassign

The FlutterMethodChannel used for navigation related platform messages.

Can be nil after destroyContext is called.

See also: Navigation Channel; Navigator Widget

Definition at line 345 of file FlutterEngine.h.

◆ pasteboard

- (FlutterPasteboard*) pasteboard

readwritenonatomicassignimplementation

This just returns the NSPasteboard so that it can be mocked in the tests.

Provided by category FlutterEngine().

Definition at line 112 of file FlutterEngine_Internal.h.

◆ platformChannel

- (FlutterMethodChannel *) platformChannel

readnonatomicassign

The FlutterMethodChannel used for core platform messages, such as information about the screen orientation.

Can be nil after destroyContext is called.

Definition at line 363 of file FlutterEngine.h.

◆ pluginAppDelegates

- (NSPointerArray*) pluginAppDelegates

readwritenonatomicstrongimplementation

All delegates added via plugin calls to addApplicationDelegate.

Provided by category FlutterEngine().

Definition at line 104 of file FlutterEngine.mm.

◆ pluginPublications

- (NSMutableDictionary*) pluginPublications

readnonatomicassignimplementation

Provided by category FlutterEngine().

Definition at line 101 of file FlutterEngine.mm.

◆ pluginRegistrars

- (NSMutableDictionary<NSString*, FlutterEngineRegistrar*>*) pluginRegistrars

readnonatomicassignimplementation

All registrars returned from registrarForPlugin:

Provided by category FlutterEngine().

Definition at line 110 of file FlutterEngine.mm.

◆ registrars

- (NSMutableDictionary<NSString*, FlutterEngineRegistrar*>*) registrars

readnonatomicassignimplementation

Provided by category FlutterEngine().

Definition at line 102 of file FlutterEngine.mm.

◆ renderer

- (FlutterRenderer*) renderer

readnonatomicassignimplementation

Provides the renderer config needed to initialize the engine and also handles external texture management.

Provided by category FlutterEngine().

Definition at line 91 of file FlutterEngine_Internal.h.

◆ restorationChannel

- (FlutterMethodChannel *) restorationChannel

readnonatomicassign

The FlutterMethodChannel used for restoration related platform messages.

Can be nil after destroyContext is called.

See also: Restoration Channel

Definition at line 355 of file FlutterEngine.h.

◆ semanticsEnabled

- (BOOL) semanticsEnabled

readwritenonatomicassignimplementation

True if the semantics is enabled. The Flutter framework starts sending semantics update through the embedder as soon as it is set to YES.

Provided by category FlutterEngine().

Definition at line 102 of file FlutterEngine_Internal.h.

◆ settingsChannel

- (FlutterBasicMessageChannel *) settingsChannel

readnonatomicassign

The FlutterBasicMessageChannel used for communicating user settings such as clock format and text scale.

Can be nil after destroyContext is called.

Definition at line 404 of file FlutterEngine.h.

◆ systemChannel

- (FlutterBasicMessageChannel *) systemChannel

readnonatomicassign

The FlutterBasicMessageChannel used for communicating system events, such as memory pressure events.

Can be nil after destroyContext is called.

See also: System Channel

Definition at line 396 of file FlutterEngine.h.

◆ terminationHandler

- (FlutterEngineTerminationHandler*) terminationHandler

readnonatomicassignimplementation

Provides the |FlutterEngineTerminationHandler| to be used for this engine.

Provided by category FlutterEngine().

Definition at line 122 of file FlutterEngine_Internal.h.

◆ textInputChannel

- (FlutterMethodChannel *) textInputChannel

readnonatomicassign

The FlutterMethodChannel used to communicate text input events to the Dart Isolate.

Can be nil after destroyContext is called.

See also: Text Input Channel

Definition at line 374 of file FlutterEngine.h.

◆ textureRegistry

- (NSObject< FlutterTextureRegistry > *) textureRegistry

readnonatomicassign

The FlutterTextureRegistry associated with this FlutterEngine (used to register textures).

Definition at line 442 of file FlutterEngine.h.

◆ viewController

- (FlutterViewController *) viewController

readwritenonatomicweak

Sets the FlutterViewController for this instance. The FlutterEngine must be running (e.g. a successful call to -runWithEntrypoint: or -runWithEntrypoint:libraryURI) before calling this method. Callers may pass nil to remove the viewController and have the engine run headless in the current process.

A FlutterEngine can only have one FlutterViewController at a time. If there is already a FlutterViewController associated with this instance, this method will replace the engine's current viewController with the newly specified one.

Setting the viewController will signal the engine to start animations and drawing, and unsetting it will signal the engine to stop animations and drawing. However, neither will impact the state of the Dart program's execution.

The FlutterViewController of this engine, if any.

This view is used by legacy APIs that assume a single view.

Setting this field from nil to a non-nil view controller also updates the view controller's engine and ID.

Setting this field from non-nil to nil will terminate the engine if allowHeadlessExecution is NO.

Setting this field from non-nil to a different non-nil FlutterViewController is prohibited and will throw an assertion error.

Definition at line 327 of file FlutterEngine.h.

◆ vmServiceUrl

- (NSURL *) vmServiceUrl

readnonatomicassign

The NSURL of the Dart VM Service for the service isolate.

This is only set in debug and profile runtime modes, and only after the Dart VM Service is ready. In release mode or before the Dart VM Service has started, it returns nil.

Definition at line 431 of file FlutterEngine.h.

The documentation for this class was generated from the following files:

shell/platform/darwin/ios/framework/Headers/FlutterEngine.h
shell/platform/darwin/macos/framework/Headers/FlutterEngine.h
shell/platform/darwin/ios/framework/Source/FlutterEngine.mm
shell/platform/darwin/macos/framework/Source/FlutterEngine.mm

Instance Methods

Class Methods

Protected Attributes

Properties

Detailed Description

Method Documentation

◆ activeTextInputView

◆ addInternalPlugins

◆ addViewController:

◆ announceAccessibilityMessage:withPriority:

◆ applicationDidEnterBackground:

◆ applicationWillEnterForeground:

◆ applicationWillTerminate:

◆ attachView

◆ cleanUpConnection:

◆ clipboardHasStrings

◆ createFlutterCompositor

◆ createShell:libraryURI:initialRoute:

◆ dealloc

◆ deregisterViewControllerForIdentifier:

◆ destroyContext

◆ didUpdateMouseCursor:

◆ dispatchPointerDataPacket:

◆ dispatchSemanticsAction:toTarget:withData:

◆ embedderAPI

◆ engineCallbackOnPlatformMessage:

◆ engineCallbackOnPreEngineRestart

◆ ensureSemanticsEnabled

◆ executableName

◆ FLUTTER_DEPRECATED

◆ flutterDidEnterBackground:

◆ flutterTextInputPlugin:focusElement:atPoint:result:

◆ flutterTextInputPlugin:requestElementsInRect:result:

◆ flutterTextInputView:didResignFirstResponderWithTextInputClient:

◆ flutterTextInputView:insertTextPlaceholderWithSize:withClient:

◆ flutterTextInputView:performAction:withClient:

◆ flutterTextInputView:removeTextPlaceholder:

◆ flutterTextInputView:showAutocorrectionPromptRectForStart:end:withClient:

◆ flutterTextInputView:showToolbar:

◆ flutterTextInputView:updateEditingClient:withDelta:

◆ flutterTextInputView:updateEditingClient:withState:

◆ flutterTextInputView:updateEditingClient:withState:withTag:

◆ flutterTextInputView:updateFloatingCursor:withClient:withPosition:

◆ flutterTextInputView:willDismissEditMenuWithTextInputClient:

◆ flutterTextInputViewScribbleInteractionBegan:

◆ flutterTextInputViewScribbleInteractionFinished:

◆ flutterViewAccessibilityDidCall

◆ flutterWillEnterForeground:

◆ generateThreadLabel:

◆ getClipboardData:

◆ getWeakNSObject

◆ handleAccessibilityEvent:

◆ handleDidChangeOcclusionState:

◆ handleMethodCall:result:

◆ handleUndoWithDirection:

◆ handleWillBecomeActive:

◆ handleWillResignActive:

◆ hasPlugin:

◆ init

◆ initWithName:

◆ initWithName:project: [1/3]

◆ initWithName:project: [2/3]

◆ initWithName:project: [3/3]

◆ initWithName:project:allowHeadlessExecution: [1/3]

◆ initWithName:project:allowHeadlessExecution: [2/3]

◆ initWithName:project:allowHeadlessExecution: [3/3]

◆ initWithName:project:allowHeadlessExecution:restorationEnabled: [1/2]

◆ initWithName:project:allowHeadlessExecution:restorationEnabled: [2/2]

◆ initWithScenario:withCompletion:

◆ iosPlatformView

◆ isProfilerEnabled

◆ isUsingImpeller

◆ launchEngine:libraryURI:entrypointArgs:

◆ loadAOTData:

◆ lookupKeyForAsset:

◆ lookupKeyForAsset:fromPackage:

◆ macOSCompositor

◆ makeBackgroundTaskQueue

◆ makeThreadHost:

◆ markTextureFrameAvailable: