#include <platform_view_ios.h>

Inheritance diagram for flutter::PlatformViewIOS:

Public Member Functions
	PlatformViewIOS (PlatformView::Delegate &delegate, const std::shared_ptr< IOSContext > &context, __weak FlutterPlatformViewsController *platform_views_controller, const flutter::TaskRunners &task_runners)

	PlatformViewIOS (PlatformView::Delegate &delegate, IOSRenderingAPI rendering_api, __weak FlutterPlatformViewsController *platform_views_controller, const flutter::TaskRunners &task_runners, const std::shared_ptr< fml::ConcurrentTaskRunner > &worker_task_runner, const std::shared_ptr< const fml::SyncSwitch > &is_gpu_disabled_sync_switch)

	~PlatformViewIOS () override

FlutterViewController *	GetOwnerViewController () const __attribute__((cf_audited_transfer))

void	SetOwnerViewController (__weak FlutterViewController *owner_controller)

void	attachView ()

void	RegisterExternalTexture (int64_t id, NSObject< FlutterTexture > *texture)

PointerDataDispatcherMaker	GetDispatcherMaker () override

void	SetSemanticsEnabled (bool enabled) override

void	HandlePlatformMessage (std::unique_ptr< flutter::PlatformMessage > message) override

std::unique_ptr< Surface >	CreateRenderingSurface () override

std::shared_ptr< ExternalViewEmbedder >	CreateExternalViewEmbedder () override

std::shared_ptr< impeller::Context >	GetImpellerContext () const override

void	SetAccessibilityFeatures (int32_t flags) override

void	UpdateSemantics (int64_t view_id, flutter::SemanticsNodeUpdates update, flutter::CustomAccessibilityActionUpdates actions) override

std::unique_ptr< VsyncWaiter >	CreateVSyncWaiter () override

void	OnPreEngineRestart () const override

std::unique_ptr< std::vector< std::string > >	ComputePlatformResolvedLocales (const std::vector< std::string > &supported_locale_data) override

const std::shared_ptr< IOSContext > &	GetIosContext ()

std::shared_ptr< PlatformMessageHandlerIos >	GetPlatformMessageHandlerIos () const

std::shared_ptr< PlatformMessageHandler >	GetPlatformMessageHandler () const override

Detailed Description

A bridge connecting the platform agnostic shell and the iOS embedding.

The shell provides and requests for UI related data and this PlatformView subclass fulfills it with iOS specific capabilities. As an example, the iOS embedding (the FlutterEngine and the FlutterViewController) sends pointer data to the shell and receives the shell's request for a Impeller AiksContext and supplies it.

Despite the name "view", this class is unrelated to UIViews on iOS and doesn't have the same lifecycle. It's a long lived bridge owned by the FlutterEngine and can be attached and detached sequentially to multiple FlutterViewControllers and FlutterViews.

Definition at line 39 of file platform_view_ios.h.

Constructor & Destructor Documentation

◆ PlatformViewIOS() [1/2]

flutter::PlatformViewIOS::PlatformViewIOS	(	PlatformView::Delegate &	delegate,
		const std::shared_ptr< IOSContext > &	context,
		__weak FlutterPlatformViewsController *	platform_views_controller,
		const flutter::TaskRunners &	task_runners
	)

Definition at line 44 of file platform_view_ios.mm.

     : PlatformView(delegate, task_runners),
       ios_context_(context),
       platform_views_controller_(platform_views_controller),
       accessibility_bridge_([this](bool enabled) { PlatformView::SetSemanticsEnabled(enabled); }),
       platform_message_handler_(
           new PlatformMessageHandlerIos(task_runners.GetPlatformTaskRunner())) {}

◆ PlatformViewIOS() [2/2]

flutter::PlatformViewIOS::PlatformViewIOS	(	PlatformView::Delegate &	delegate,
		IOSRenderingAPI	rendering_api,
		__weak FlutterPlatformViewsController *	platform_views_controller,
		const flutter::TaskRunners &	task_runners,
		const std::shared_ptr< fml::ConcurrentTaskRunner > &	worker_task_runner,
		const std::shared_ptr< const fml::SyncSwitch > &	is_gpu_disabled_sync_switch
	)

explicit

Definition at line 55 of file platform_view_ios.mm.

     : PlatformViewIOS(delegate,
                       IOSContext::Create(rendering_api,
                                          delegate.OnPlatformViewGetSettings().enable_impeller
                                              ? IOSRenderingBackend::kImpeller
                                              : IOSRenderingBackend::kSkia,
                                          is_gpu_disabled_sync_switch,
                                          delegate.OnPlatformViewGetSettings()),
                       platform_views_controller,
                       task_runners) {}

References flutter::kImpeller, and flutter::kSkia.

◆ ~PlatformViewIOS()

flutter::PlatformViewIOS::~PlatformViewIOS ( )

overridedefault

Member Function Documentation

◆ attachView()

void flutter::PlatformViewIOS::attachView ( )

Called one time per FlutterViewController when the FlutterViewController's UIView is first loaded.

Can be used to perform late initialization after FlutterViewController's init.

Definition at line 114 of file platform_view_ios.mm.

                                  {
   FML_DCHECK(owner_controller_);
   FML_DCHECK(owner_controller_.isViewLoaded) << "FlutterViewController's view should be loaded "
                                                 "before attaching to PlatformViewIOS.";
   FlutterView* flutter_view = static_cast<FlutterView*>(owner_controller_.view);
   CALayer* ca_layer = flutter_view.layer;
   ios_surface_ = IOSSurface::Create(ios_context_, ca_layer);
   FML_DCHECK(ios_surface_ != nullptr);
  
   if (accessibility_bridge_) {
     accessibility_bridge_.Set(std::make_unique<AccessibilityBridge>(
         owner_controller_, this, owner_controller_.platformViewsController));
   }
 }

References flutter::IOSSurface::Create().

Referenced by SetOwnerViewController().

◆ ComputePlatformResolvedLocales()

std::unique_ptr< std::vector< std::string > > flutter::PlatformViewIOS::ComputePlatformResolvedLocales ( const std::vector< std::string > & supported_locale_data )

override

Definition at line 212 of file platform_view_ios.mm.

                                                        {
   size_t localeDataLength = 3;
   NSMutableArray<NSString*>* supported_locale_identifiers =
       [NSMutableArray arrayWithCapacity:supported_locale_data.size() / localeDataLength];
   for (size_t i = 0; i < supported_locale_data.size(); i += localeDataLength) {
     NSDictionary<NSString*, NSString*>* dict = @{
       NSLocaleLanguageCode : [NSString stringWithUTF8String:supported_locale_data[i].c_str()]
           ?: @"",
       NSLocaleCountryCode : [NSString stringWithUTF8String:supported_locale_data[i + 1].c_str()]
           ?: @"",
       NSLocaleScriptCode : [NSString stringWithUTF8String:supported_locale_data[i + 2].c_str()]
           ?: @""
     };
     [supported_locale_identifiers addObject:[NSLocale localeIdentifierFromComponents:dict]];
   }
   NSArray<NSString*>* result =
       [NSBundle preferredLocalizationsFromArray:supported_locale_identifiers];
  
   // Output format should be either empty or 3 strings for language, country, and script.
   std::unique_ptr<std::vector<std::string>> out = std::make_unique<std::vector<std::string>>();
  
   if (result != nullptr && [result count] > 0) {
     NSLocale* locale = [NSLocale localeWithLocaleIdentifier:[result firstObject]];
     NSString* languageCode = [locale languageCode];
     out->emplace_back(languageCode == nullptr ? "" : languageCode.UTF8String);
     NSString* countryCode = [locale countryCode];
     out->emplace_back(countryCode == nullptr ? "" : countryCode.UTF8String);
     NSString* scriptCode = [locale scriptCode];
     out->emplace_back(scriptCode == nullptr ? "" : scriptCode.UTF8String);
   }
   return out;
 }

◆ CreateExternalViewEmbedder()

std::shared_ptr< ExternalViewEmbedder > flutter::PlatformViewIOS::CreateExternalViewEmbedder ( )

override

Definition at line 153 of file platform_view_ios.mm.

                                                                                 {
   return std::make_shared<IOSExternalViewEmbedder>(platform_views_controller_, ios_context_);
 }

◆ CreateRenderingSurface()

std::unique_ptr< Surface > flutter::PlatformViewIOS::CreateRenderingSurface ( )

override

Definition at line 141 of file platform_view_ios.mm.

                                                                {
   FML_DCHECK(task_runners_.GetRasterTaskRunner()->RunsTasksOnCurrentThread());
   std::lock_guard<std::mutex> guard(ios_surface_mutex_);
   if (!ios_surface_) {
     FML_DLOG(INFO) << "Could not CreateRenderingSurface, this PlatformViewIOS "
                       "has no ViewController.";
     return nullptr;
   }
   return ios_surface_->CreateGPUSurface();
 }

◆ CreateVSyncWaiter()

std::unique_ptr< VsyncWaiter > flutter::PlatformViewIOS::CreateVSyncWaiter ( )

override

Definition at line 197 of file platform_view_ios.mm.

                                                               {
   return std::make_unique<VsyncWaiterIOS>(task_runners_);
 }

◆ GetDispatcherMaker()

PointerDataDispatcherMaker flutter::PlatformViewIOS::GetDispatcherMaker ( )

override

Definition at line 129 of file platform_view_ios.mm.

                                                                {
   return [](DefaultPointerDataDispatcher::Delegate& delegate) {
     return std::make_unique<SmoothPointerDataDispatcher>(delegate);
   };
 }

◆ GetImpellerContext()

std::shared_ptr< impeller::Context > flutter::PlatformViewIOS::GetImpellerContext ( ) const

override

Definition at line 158 of file platform_view_ios.mm.

                                                                          {
   return ios_context_->GetImpellerContext();
 }

◆ GetIosContext()

const std::shared_ptr<IOSContext>& flutter::PlatformViewIOS::GetIosContext ( )

inline

Accessor for the IOSContext associated with the platform view.

Definition at line 121 of file platform_view_ios.h.

121 { return ios_context_; }

◆ GetOwnerViewController()

FlutterViewController * flutter::PlatformViewIOS::GetOwnerViewController ( ) const

Returns the FlutterViewController currently attached to the FlutterEngine owning this PlatformViewIOS.

Definition at line 79 of file platform_view_ios.mm.

                                                                      {
   return owner_controller_;
 }

◆ GetPlatformMessageHandler()

std::shared_ptr<PlatformMessageHandler> flutter::PlatformViewIOS::GetPlatformMessageHandler ( ) const

inlineoverride

Definition at line 127 of file platform_view_ios.h.

                                                                                    {
     return platform_message_handler_;
   }

◆ GetPlatformMessageHandlerIos()

std::shared_ptr<PlatformMessageHandlerIos> flutter::PlatformViewIOS::GetPlatformMessageHandlerIos ( ) const

inline

Definition at line 123 of file platform_view_ios.h.

                                                                                 {
     return platform_message_handler_;
   }

◆ HandlePlatformMessage()

void flutter::PlatformViewIOS::HandlePlatformMessage ( std::unique_ptr< flutter::PlatformMessage > message )

override

Definition at line 75 of file platform_view_ios.mm.

                                                                                          {
   platform_message_handler_->HandlePlatformMessage(std::move(message));
 }

◆ OnPreEngineRestart()

void flutter::PlatformViewIOS::OnPreEngineRestart ( ) const

override

Definition at line 201 of file platform_view_ios.mm.

                                                {
   if (accessibility_bridge_) {
     accessibility_bridge_.get()->clearState();
   }
   if (!owner_controller_) {
     return;
   }
   [owner_controller_.platformViewsController reset];
   [owner_controller_.restorationPlugin reset];
 }

◆ RegisterExternalTexture()

void flutter::PlatformViewIOS::RegisterExternalTexture	(	int64_t	id,
		NSObject< FlutterTexture > *	texture
	)

Called through when an external texture such as video or camera is given to the FlutterEngine or FlutterViewController.

Definition at line 135 of file platform_view_ios.mm.

                                                                                  {
   RegisterTexture(ios_context_->CreateExternalTexture(texture_id, texture));
 }

References texture_id.

◆ SetAccessibilityFeatures()

void flutter::PlatformViewIOS::SetAccessibilityFeatures ( int32_t flags )

override

Definition at line 180 of file platform_view_ios.mm.

                                                             {
   PlatformView::SetAccessibilityFeatures(flags);
 }

◆ SetOwnerViewController()

void flutter::PlatformViewIOS::SetOwnerViewController ( __weak FlutterViewController * owner_controller )

Updates the FlutterViewController currently attached to the FlutterEngine owning this PlatformViewIOS. This should be updated when the FlutterEngine is given a new FlutterViewController.

Definition at line 83 of file platform_view_ios.mm.

                                                                                            {
   FML_DCHECK(task_runners_.GetPlatformTaskRunner()->RunsTasksOnCurrentThread());
   std::lock_guard<std::mutex> guard(ios_surface_mutex_);
   if (ios_surface_ || !owner_controller) {
     NotifyDestroyed();
     ios_surface_.reset();
     accessibility_bridge_.Clear();
   }
   owner_controller_ = owner_controller;
  
   // Add an observer that will clear out the owner_controller_ ivar and
   // the accessibility_bridge_ in case the view controller is deleted.
   dealloc_view_controller_observer_.reset([[NSNotificationCenter defaultCenter]
       addObserverForName:FlutterViewControllerWillDealloc
                   object:owner_controller_
                    queue:[NSOperationQueue mainQueue]
               usingBlock:^(NSNotification* note) {
                 // Implicit copy of 'this' is fine.
                 accessibility_bridge_.Clear();
                 owner_controller_ = nil;
               }]);
  
   if (owner_controller_ && owner_controller_.isViewLoaded) {
     this->attachView();
   }
   // Do not call `NotifyCreated()` here - let FlutterViewController take care
   // of that when its Viewport is sized.  If `NotifyCreated()` is called here,
   // it can occasionally get invoked before the viewport is sized resulting in
   // a framebuffer that will not be able to completely attach.
 }

References attachView(), and FlutterViewControllerWillDealloc.

◆ SetSemanticsEnabled()

void flutter::PlatformViewIOS::SetSemanticsEnabled ( bool enabled )

override

Definition at line 163 of file platform_view_ios.mm.

                                                       {
   if (!owner_controller_) {
     FML_LOG(WARNING) << "Could not set semantics to enabled, this "
                         "PlatformViewIOS has no ViewController.";
     return;
   }
   if (enabled && !accessibility_bridge_) {
     accessibility_bridge_.Set(std::make_unique<AccessibilityBridge>(
         owner_controller_, this, owner_controller_.platformViewsController));
   } else if (!enabled && accessibility_bridge_) {
     accessibility_bridge_.Clear();
   } else {
     PlatformView::SetSemanticsEnabled(enabled);
   }
 }

◆ UpdateSemantics()

void flutter::PlatformViewIOS::UpdateSemantics	(	int64_t	view_id,
		flutter::SemanticsNodeUpdates	update,
		flutter::CustomAccessibilityActionUpdates	actions
	)

override

Definition at line 185 of file platform_view_ios.mm.

                                                                                        {
   FML_DCHECK(owner_controller_);
   if (accessibility_bridge_) {
     accessibility_bridge_.get()->UpdateSemantics(std::move(update), actions);
     [[NSNotificationCenter defaultCenter] postNotificationName:FlutterSemanticsUpdateNotification
                                                         object:owner_controller_];
   }
 }

References FlutterSemanticsUpdateNotification.

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

shell/platform/darwin/ios/platform_view_ios.h
shell/platform/darwin/ios/platform_view_ios.mm

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ PlatformViewIOS() [1/2]

◆ PlatformViewIOS() [2/2]

◆ ~PlatformViewIOS()

Member Function Documentation

◆ attachView()

◆ ComputePlatformResolvedLocales()

◆ CreateExternalViewEmbedder()

◆ CreateRenderingSurface()

◆ CreateVSyncWaiter()

◆ GetDispatcherMaker()

◆ GetImpellerContext()

◆ GetIosContext()

◆ GetOwnerViewController()

◆ GetPlatformMessageHandler()

◆ GetPlatformMessageHandlerIos()

◆ HandlePlatformMessage()

◆ OnPreEngineRestart()

◆ RegisterExternalTexture()

◆ SetAccessibilityFeatures()

◆ SetOwnerViewController()

◆ SetSemanticsEnabled()

◆ UpdateSemantics()