FlutterEngine(Test) Category Reference

#include <FlutterEngine_Test.h>

Inheritance diagram for FlutterEngine(Test):

Instance Methods
(flutter::Shell &)	- shell
(void)	- setBinaryMessenger:
(flutter::IOSRenderingAPI)	- platformViewsRenderingAPI
(void)	- waitForFirstFrame:callback:
(FlutterEngine *)	- spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:
(const flutter::ThreadHost &)	- threadHost
(void)	- updateDisplays
(void)	- flutterTextInputView:performAction:withClient:
(void)	- sceneWillEnterForeground:
(void)	- sceneDidEnterBackground:
(void)	- applicationWillEnterForeground:
(void)	- applicationDidEnterBackground:
Instance Methods inherited from <FlutterBinaryMessenger>
(NSObject< FlutterTaskQueue > *)	- makeBackgroundTaskQueue
	TODO(gaaclarke): Remove optional when macos supports Background Platform Channels.
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:taskQueue:
(void)	- sendOnChannel:message:
(void)	- sendOnChannel:message:binaryReply:
(FlutterBinaryMessengerConnection)	- setMessageHandlerOnChannel:binaryMessageHandler:
(void)	- cleanUpConnection:

Properties
FlutterEngineProcTable &	embedderAPI
BOOL	enableEmbedderAPI
flutter::FlutterCompositor *	macOSCompositor

Detailed Description

Definition at line 23 of file FlutterEngine_Test.h.

Method Documentation

applicationDidEnterBackground:

- (void) applicationDidEnterBackground:

(NSNotification *)

notification

Extends class FlutterEngine.

Definition at line 822 of file FlutterEngine.mm.

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

applicationWillEnterForeground:

- (void) applicationWillEnterForeground:

(NSNotification *)

notification

Extends class FlutterEngine.

Definition at line 822 of file FlutterEngine.mm.

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

flutterTextInputView:performAction:withClient:

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

Extends class FlutterEngine.

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 ]];
}

platformViewsRenderingAPI

- (IOSRenderingAPI FlutterEngine(Test)):

Extends class FlutterEngine.

Definition at line 157 of file FlutterEngine.mm.

                                                    {
  return _renderingApi;
}

sceneDidEnterBackground:

- (void) sceneDidEnterBackground:

(ios(13.0))

API_AVAILABLE

sceneWillEnterForeground:

- (void) sceneWillEnterForeground:

(ios(13.0))

API_AVAILABLE

setBinaryMessenger:

- (void) setBinaryMessenger:

(FlutterBinaryMessengerRelay *)

binaryMessenger

Extends class FlutterEngine.

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];
  }
}

shell

- (Shell & FlutterEngine(Test)):

Extends class FlutterEngine.

Definition at line 157 of file FlutterEngine.mm.

                       {
  FML_DCHECK(_shell);
  return *_shell;
}

spawnWithEntrypoint:libraryURI:initialRoute:entrypointArgs:

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

Extends class FlutterEngine.

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];
}

threadHost

- (const ThreadHost & FlutterEngine(Test)):

Extends class FlutterEngine.

Definition at line 822 of file FlutterEngine.mm.

                                       {
  return *_threadHost;
}

updateDisplays

- (void) updateDisplays

Extends class FlutterEngine.

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));
}

waitForFirstFrame:callback:

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

Extends class FlutterEngine.

Property Documentation

embedderAPI

- (FlutterEngineProcTable&) embedderAPI

readwritenonatomicassign

Function pointers for interacting with the embedder.h API.

Extends class FlutterEngine.

Definition at line 25 of file FlutterEngine_Test.h.

enableEmbedderAPI

- (BOOL) enableEmbedderAPI

readnonatomicassign

Extends class FlutterEngine.

Definition at line 26 of file FlutterEngine_Test.h.

macOSCompositor

- (FlutterCompositor* FlutterEngine(Test)):

readnonatomicassign

The FlutterCompositor object currently in use by the FlutterEngine.

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

Extends class FlutterEngine.

Definition at line 44 of file FlutterEngineTest.mm.

---

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

• shell/platform/darwin/ios/framework/Source/FlutterEngine_Test.h
• shell/platform/darwin/macos/framework/Source/FlutterEngineTest.mm