A client interface that the RuntimeController uses to define handlers for PlatformConfiguration requests. More...

#include <platform_configuration.h>

Inheritance diagram for flutter::PlatformConfigurationClient:

Public Member Functions
virtual std::string	DefaultRouteName ()=0
	The route or path that the embedder requested when the application was launched.

virtual void	ScheduleFrame ()=0
	Requests that, at the next appropriate opportunity, a new frame be scheduled for rendering.

virtual void	EndWarmUpFrame ()=0
	Called when a warm up frame has ended.

virtual void	Render (int64_t view_id, Scene *scene, double width, double height)=0
	Updates the client's rendering on the GPU with the newly provided Scene.

virtual void	UpdateSemantics (SemanticsUpdate *update)=0
	Receives an updated semantics tree from the Framework.

virtual void	HandlePlatformMessage (std::unique_ptr< PlatformMessage > message)=0
	When the Flutter application has a message to send to the underlying platform, the message needs to be forwarded to the platform on the appropriate thread (via the platform task runner). The PlatformConfiguration delegates this task to the engine via this method.

virtual FontCollection &	GetFontCollection ()=0
	Returns the current collection of fonts available on the platform.

virtual std::shared_ptr< AssetManager >	GetAssetManager ()=0
	Returns the current collection of assets available on the platform.

virtual void	UpdateIsolateDescription (const std::string isolate_name, int64_t isolate_port)=0
	Notifies this client of the name of the root isolate and its port when that isolate is launched, restarted (in the cold-restart scenario) or the application itself updates the name of the root isolate (via `Window.setIsolateDebugName` in `window.dart`). The name of the isolate is meaningless to the engine but is used in instrumentation and tooling. Currently, this information is to update the service protocol list of available root isolates running in the VM and their names so that the appropriate isolate can be selected in the tools for debugging and instrumentation.

virtual void	SetNeedsReportTimings (bool value)=0
	Notifies this client that the application has an opinion about whether its frame timings need to be reported backed to it. Due to the asynchronous nature of rendering in Flutter, it is not possible for the application to determine the total time it took to render a specific frame. While the layer-tree is constructed on the UI thread, it needs to be rendering on the raster thread. Dart code cannot execute on this thread. So any instrumentation about the frame times gathered on this thread needs to be aggregated and sent back to the UI thread for processing in Dart.

virtual std::shared_ptr< const fml::Mapping >	GetPersistentIsolateData ()=0
	The embedder can specify data that the isolate can request synchronously on launch. This accessor fetches that data.

virtual std::unique_ptr< std::vector< std::string > >	ComputePlatformResolvedLocale (const std::vector< std::string > &supported_locale_data)=0
	Directly invokes platform-specific APIs to compute the locale the platform would have natively resolved to.

virtual void	RequestDartDeferredLibrary (intptr_t loading_unit_id)=0
	Invoked when the Dart VM requests that a deferred library be loaded. Notifies the engine that the deferred library identified by the specified loading unit id should be downloaded and loaded into the Dart VM via `LoadDartDeferredLibrary`

virtual void	SendChannelUpdate (std::string name, bool listening)=0
	Invoked when a listener is registered on a platform channel.

virtual double	GetScaledFontSize (double unscaled_font_size, int configuration_id) const =0
	Synchronously invokes platform-specific APIs to apply the system text scaling on the given unscaled font size.

virtual std::shared_ptr< PlatformIsolateManager >	GetPlatformIsolateManager ()=0

Protected Member Functions
virtual	~PlatformConfigurationClient ()

Detailed Description

A client interface that the RuntimeController uses to define handlers for PlatformConfiguration requests.

See also: PlatformConfiguration

Definition at line 52 of file platform_configuration.h.

Constructor & Destructor Documentation

◆ ~PlatformConfigurationClient()

flutter::PlatformConfigurationClient::~PlatformConfigurationClient ( )

protectedvirtual

Definition at line 32 of file platform_configuration.cc.

32{}

Member Function Documentation

◆ ComputePlatformResolvedLocale()

virtual std::unique_ptr< std::vector< std::string > > flutter::PlatformConfigurationClient::ComputePlatformResolvedLocale ( const std::vector< std::string > & supported_locale_data )

pure virtual

Directly invokes platform-specific APIs to compute the locale the platform would have natively resolved to.

Parameters

[in] supported_locale_data The vector of strings that represents the locales supported by the app. Each locale consists of three strings: languageCode, countryCode, and scriptCode in that order.

Returns: A vector of 3 strings languageCode, countryCode, and scriptCode that represents the locale selected by the platform. Empty strings mean the value was unassigned. Empty vector represents a null locale.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ DefaultRouteName()

virtual std::string flutter::PlatformConfigurationClient::DefaultRouteName ( )

pure virtual

The route or path that the embedder requested when the application was launched.

This will be the string "`/`" if no particular route was requested.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ EndWarmUpFrame()

virtual void flutter::PlatformConfigurationClient::EndWarmUpFrame ( )

pure virtual

Called when a warm up frame has ended.

      For more introduction, see `Animator::EndWarmUpFrame`.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ GetAssetManager()

virtual std::shared_ptr< AssetManager > flutter::PlatformConfigurationClient::GetAssetManager ( )

pure virtual

Returns the current collection of assets available on the platform.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ GetFontCollection()

virtual FontCollection & flutter::PlatformConfigurationClient::GetFontCollection ( )

pure virtual

Returns the current collection of fonts available on the platform.

This function reads an XML file and makes font families and collections of them. MinikinFontForTest is used for FontFamily creation.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ GetPersistentIsolateData()

virtual std::shared_ptr< const fml::Mapping > flutter::PlatformConfigurationClient::GetPersistentIsolateData ( )

pure virtual

The embedder can specify data that the isolate can request synchronously on launch. This accessor fetches that data.

This data is persistent for the duration of the Flutter application and is available even after isolate restarts. Because of this lifecycle, the size of this data must be kept to a minimum.

For asynchronous communication between the embedder and isolate, a platform channel may be used.

Returns: A map of the isolate data that the framework can request upon launch.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ GetPlatformIsolateManager()

virtual std::shared_ptr< PlatformIsolateManager > flutter::PlatformConfigurationClient::GetPlatformIsolateManager ( )

pure virtual

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ GetScaledFontSize()

virtual double flutter::PlatformConfigurationClient::GetScaledFontSize	(	double	unscaled_font_size,
		int	configuration_id
	)		const

pure virtual

Synchronously invokes platform-specific APIs to apply the system text scaling on the given unscaled font size.

Platforms that support this feature (currently it's only implemented for Android SDK level 34+) will send a valid configuration_id to potential callers, before this method can be called.

Parameters

[in]	unscaled_font_size	The unscaled font size specified by the app developer. The value is in logical pixels, and is guaranteed to be finite and non-negative.
[in]	configuration_id	The unique id of the configuration to use for computing the scaled font size.

Returns: The scaled font size in logical pixels, or -1 if the given configuration_id did not match a valid configuration.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ HandlePlatformMessage()

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

pure virtual

When the Flutter application has a message to send to the underlying platform, the message needs to be forwarded to the platform on the appropriate thread (via the platform task runner). The PlatformConfiguration delegates this task to the engine via this method.

See also: PlatformView::HandlePlatformMessage

Parameters

[in] message The message from the Flutter application to send to the underlying platform.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ Render()

virtual void flutter::PlatformConfigurationClient::Render	(	int64_t	view_id,
		Scene *	scene,
		double	width,
		double	height
	)

pure virtual

Updates the client's rendering on the GPU with the newly provided Scene.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ RequestDartDeferredLibrary()

virtual void flutter::PlatformConfigurationClient::RequestDartDeferredLibrary ( intptr_t loading_unit_id )

pure virtual

Invoked when the Dart VM requests that a deferred library be loaded. Notifies the engine that the deferred library identified by the specified loading unit id should be downloaded and loaded into the Dart VM via LoadDartDeferredLibrary

Upon encountering errors or otherwise failing to load a loading unit with the specified id, the failure should be directly reported to dart by calling LoadDartDeferredLibraryFailure to ensure the waiting dart future completes with an error.

Parameters

[in] loading_unit_id The unique id of the deferred library's loading unit. This id is to be passed back into LoadDartDeferredLibrary in order to identify which deferred library to load.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ ScheduleFrame()

virtual void flutter::PlatformConfigurationClient::ScheduleFrame ( )

pure virtual

Requests that, at the next appropriate opportunity, a new frame be scheduled for rendering.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ SendChannelUpdate()

virtual void flutter::PlatformConfigurationClient::SendChannelUpdate	(	std::string	name,
		bool	listening
	)

pure virtual

Invoked when a listener is registered on a platform channel.

Parameters

[in]	name	The name of the platform channel to which a listener has been registered or cleared.
[in]	listening	Whether the listener has been set (true) or cleared (false).

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ SetNeedsReportTimings()

virtual void flutter::PlatformConfigurationClient::SetNeedsReportTimings ( bool value )

pure virtual

Notifies this client that the application has an opinion about whether its frame timings need to be reported backed to it. Due to the asynchronous nature of rendering in Flutter, it is not possible for the application to determine the total time it took to render a specific frame. While the layer-tree is constructed on the UI thread, it needs to be rendering on the raster thread. Dart code cannot execute on this thread. So any instrumentation about the frame times gathered on this thread needs to be aggregated and sent back to the UI thread for processing in Dart.

When the application indicates that frame times need to be reported, it collects this information till a specified number of data points are gathered. Then this information is sent back to Dart code via Engine::ReportTimings.

This option is engine counterpart of the Window._setNeedsReportTimings in window.dart.

Parameters

[in] needs_reporting If reporting information should be collected and send back to Dart.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ UpdateIsolateDescription()

virtual void flutter::PlatformConfigurationClient::UpdateIsolateDescription	(	const std::string	isolate_name,
		int64_t	isolate_port
	)

pure virtual

Notifies this client of the name of the root isolate and its port when that isolate is launched, restarted (in the cold-restart scenario) or the application itself updates the name of the root isolate (via Window.setIsolateDebugName in window.dart). The name of the isolate is meaningless to the engine but is used in instrumentation and tooling. Currently, this information is to update the service protocol list of available root isolates running in the VM and their names so that the appropriate isolate can be selected in the tools for debugging and instrumentation.

Parameters

[in]	isolate_name	The isolate name
[in]	isolate_port	The isolate port

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

◆ UpdateSemantics()

virtual void flutter::PlatformConfigurationClient::UpdateSemantics ( SemanticsUpdate * update )

pure virtual

Receives an updated semantics tree from the Framework.

Parameters

[in] update The updated semantic tree to apply.

Implemented in flutter::testing::FakePlatformConfigurationClient, and flutter::RuntimeController.

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

lib/ui/window/platform_configuration.h
lib/ui/window/platform_configuration.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~PlatformConfigurationClient()

Member Function Documentation

◆ ComputePlatformResolvedLocale()

◆ DefaultRouteName()

◆ EndWarmUpFrame()

◆ GetAssetManager()

◆ GetFontCollection()

◆ GetPersistentIsolateData()

◆ GetPlatformIsolateManager()

◆ GetScaledFontSize()

◆ HandlePlatformMessage()

◆ Render()

◆ RequestDartDeferredLibrary()

◆ ScheduleFrame()

◆ SendChannelUpdate()

◆ SetNeedsReportTimings()

◆ UpdateIsolateDescription()

◆ UpdateSemantics()