flutter::PlatformConfigurationNativeApi Class Reference

#include <platform_configuration.h>

Static Public Member Functions
static std::string	DefaultRouteName ()
static void	ScheduleFrame ()
static void	EndWarmUpFrame ()
static void	Render (int64_t view_id, Scene *scene, double width, double height)
static void	UpdateSemantics (int64_t viewId, SemanticsUpdate *update)
static void	SetApplicationLocale (std::string locale)
static void	SetSemanticsTreeEnabled (bool enabled)
static void	SetNeedsReportTimings (bool value)
static Dart_Handle	GetPersistentIsolateData ()
static Dart_Handle	ComputePlatformResolvedLocale (Dart_Handle supportedLocalesHandle)
static void	SetIsolateDebugName (const std::string &name)
static Dart_Handle	SendPlatformMessage (const std::string &name, Dart_Handle callback, Dart_Handle data_handle)
static Dart_Handle	SendPortPlatformMessage (const std::string &name, Dart_Handle identifier, Dart_Handle send_port, Dart_Handle data_handle)
static void	RespondToPlatformMessage (int response_id, const tonic::DartByteData &data)
static void	SendChannelUpdate (const std::string &name, bool listening)
static void	RequestViewFocusChange (int64_t view_id, int64_t state, int64_t direction)
static int	RequestDartPerformanceMode (int mode)
	Requests the Dart VM to adjusts the GC heuristics based on the requested performance_mode. Returns the old performance mode.
static Dart_PerformanceMode	GetDartPerformanceMode ()
	Returns the current performance mode of the Dart VM. Defaults to Dart_PerformanceMode_Default if no prior requests to change the performance mode have been made.
static int64_t	GetRootIsolateToken ()
static void	RegisterBackgroundIsolate (int64_t root_isolate_token)
static double	GetScaledFontSize (double unscaled_font_size, int configuration_id)

Detailed Description

Definition at line 628 of file platform_configuration.h.

Member Function Documentation

ComputePlatformResolvedLocale()

Dart_Handle flutter::PlatformConfigurationNativeApi::ComputePlatformResolvedLocale ( Dart_Handle  supportedLocalesHandle )

static

Definition at line 696 of file platform_configuration.cc.

                                        {
  UIDartState::ThrowIfUIOperationsProhibited();
  std::vector<std::string> supportedLocales =
      tonic::DartConverter<std::vector<std::string>>::FromDart(
          supportedLocalesHandle);
 
  std::vector<std::string> results =
      *UIDartState::Current()
           ->platform_configuration()
           ->client()
           ->ComputePlatformResolvedLocale(supportedLocales);
 
  return tonic::DartConverter<std::vector<std::string>>::ToDart(results);
}

References flutter::PlatformConfiguration::client(), flutter::PlatformConfigurationClient::ComputePlatformResolvedLocale(), flutter::UIDartState::Current(), flutter::UIDartState::platform_configuration(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

DefaultRouteName()

std::string flutter::PlatformConfigurationNativeApi::DefaultRouteName ( )

static

Definition at line 712 of file platform_configuration.cc.

                                                           {
  UIDartState::ThrowIfUIOperationsProhibited();
  return UIDartState::Current()
      ->platform_configuration()
      ->client()
      ->DefaultRouteName();
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::PlatformConfigurationClient::DefaultRouteName(), flutter::UIDartState::platform_configuration(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

EndWarmUpFrame()

void flutter::PlatformConfigurationNativeApi::EndWarmUpFrame ( )

static

Definition at line 668 of file platform_configuration.cc.

                                                    {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()->platform_configuration()->client()->EndWarmUpFrame();
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::PlatformConfigurationClient::EndWarmUpFrame(), flutter::UIDartState::platform_configuration(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

GetDartPerformanceMode()

Dart_PerformanceMode flutter::PlatformConfigurationNativeApi::GetDartPerformanceMode ( )

static

Returns the current performance mode of the Dart VM. Defaults to Dart_PerformanceMode_Default if no prior requests to change the performance mode have been made.

Definition at line 637 of file platform_configuration.cc.

                                                                            {
  return current_performance_mode_;
}

Referenced by flutter::RuntimeController::NotifyIdle().

GetPersistentIsolateData()

Dart_Handle flutter::PlatformConfigurationNativeApi::GetPersistentIsolateData ( )

static

Definition at line 647 of file platform_configuration.cc.

                                                                     {
  UIDartState::ThrowIfUIOperationsProhibited();
 
  auto persistent_isolate_data = UIDartState::Current()
                                     ->platform_configuration()
                                     ->client()
                                     ->GetPersistentIsolateData();
 
  if (!persistent_isolate_data) {
    return Dart_Null();
  }
 
  return tonic::DartByteData::Create(persistent_isolate_data->GetMapping(),
                                     persistent_isolate_data->GetSize());
}

References flutter::PlatformConfiguration::client(), tonic::DartByteData::Create(), flutter::UIDartState::Current(), flutter::PlatformConfigurationClient::GetPersistentIsolateData(), flutter::UIDartState::platform_configuration(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

GetRootIsolateToken()

int64_t flutter::PlatformConfigurationNativeApi::GetRootIsolateToken ( )

static

Definition at line 720 of file platform_configuration.cc.

                                                            {
  UIDartState* dart_state = UIDartState::Current();
  FML_DCHECK(dart_state);
  return dart_state->GetRootIsolateToken();
}

References flutter::UIDartState::Current(), FML_DCHECK, and flutter::UIDartState::GetRootIsolateToken().

GetScaledFontSize()

double flutter::PlatformConfigurationNativeApi::GetScaledFontSize ( double  unscaled_font_size, int  configuration_id  )

static

Definition at line 745 of file platform_configuration.cc.

                          {
  UIDartState::ThrowIfUIOperationsProhibited();
  return UIDartState::Current()
      ->platform_configuration()
      ->client()
      ->GetScaledFontSize(unscaled_font_size, configuration_id);
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::PlatformConfigurationClient::GetScaledFontSize(), flutter::UIDartState::platform_configuration(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

RegisterBackgroundIsolate()

void flutter::PlatformConfigurationNativeApi::RegisterBackgroundIsolate ( int64_t  root_isolate_token )

static

Definition at line 726 of file platform_configuration.cc.

                                {
  UIDartState* dart_state = UIDartState::Current();
  FML_DCHECK(dart_state && !dart_state->IsRootIsolate());
  auto platform_message_handler =
      (*static_cast<std::shared_ptr<PlatformMessageHandlerStorage>*>(
          Dart_CurrentIsolateGroupData()));
  FML_DCHECK(platform_message_handler);
  auto weak_platform_message_handler =
      platform_message_handler->GetPlatformMessageHandler(root_isolate_token);
  dart_state->SetPlatformMessageHandler(weak_platform_message_handler);
}

References flutter::UIDartState::Current(), FML_DCHECK, flutter::UIDartState::IsRootIsolate(), and flutter::UIDartState::SetPlatformMessageHandler().

Render()

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

static

Definition at line 520 of file platform_configuration.cc.

                                                           {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()->platform_configuration()->client()->Render(
      view_id, scene, width, height);
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), height, flutter::UIDartState::platform_configuration(), flutter::PlatformConfigurationClient::Render(), flutter::UIDartState::ThrowIfUIOperationsProhibited(), view_id, and width.

RequestDartPerformanceMode()

int flutter::PlatformConfigurationNativeApi::RequestDartPerformanceMode ( int  mode )

static

Requests the Dart VM to adjusts the GC heuristics based on the requested performance_mode. Returns the old performance mode.

Requesting a performance mode doesn't guarantee any performance characteristics. This is best effort, and should be used after careful consideration of the various GC trade-offs.

Parameters

[in]

performance_mode

The requested performance mode. Please refer to documentation of Dart_PerformanceMode for more details about what each performance mode does.

Definition at line 641 of file platform_configuration.cc.

                                                                       {
  UIDartState::ThrowIfUIOperationsProhibited();
  current_performance_mode_ = static_cast<Dart_PerformanceMode>(mode);
  return Dart_SetPerformanceMode(current_performance_mode_);
}

References flutter::mode, and flutter::UIDartState::ThrowIfUIOperationsProhibited().

RequestViewFocusChange()

void flutter::PlatformConfigurationNativeApi::RequestViewFocusChange ( int64_t  view_id, int64_t  state, int64_t  direction  )

static

Definition at line 599 of file platform_configuration.cc.

                                                                               {
  ViewFocusChangeRequest request{view_id,  //
                                 static_cast<ViewFocusState>(state),
                                 static_cast<ViewFocusDirection>(direction)};
  UIDartState* dart_state = UIDartState::Current();
  dart_state->platform_configuration()->client()->RequestViewFocusChange(
      request);
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::UIDartState::platform_configuration(), flutter::PlatformConfigurationClient::RequestViewFocusChange(), and view_id.

RespondToPlatformMessage()

void flutter::PlatformConfigurationNativeApi::RespondToPlatformMessage ( int  response_id, const tonic::DartByteData &  data  )

static

Definition at line 610 of file platform_configuration.cc.

                                   {
  if (Dart_IsNull(data.dart_handle())) {
    UIDartState::Current()
        ->platform_configuration()
        ->CompletePlatformMessageEmptyResponse(response_id);
  } else {
    // TODO(engine): Avoid this copy.
    const uint8_t* buffer = static_cast<const uint8_t*>(data.data());
    UIDartState::Current()
        ->platform_configuration()
        ->CompletePlatformMessageResponse(
            response_id,
            std::vector<uint8_t>(buffer, buffer + data.length_in_bytes()));
  }
}

References flutter::buffer, flutter::PlatformConfiguration::CompletePlatformMessageEmptyResponse(), flutter::PlatformConfiguration::CompletePlatformMessageResponse(), flutter::UIDartState::Current(), flutter::data, and flutter::UIDartState::platform_configuration().

ScheduleFrame()

void flutter::PlatformConfigurationNativeApi::ScheduleFrame ( )

static

Definition at line 663 of file platform_configuration.cc.

                                                   {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()->platform_configuration()->client()->ScheduleFrame();
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::UIDartState::platform_configuration(), flutter::PlatformConfigurationClient::ScheduleFrame(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

SendChannelUpdate()

void flutter::PlatformConfigurationNativeApi::SendChannelUpdate ( const std::string &  name, bool  listening  )

static

Definition at line 739 of file platform_configuration.cc.

                                                                       {
  UIDartState::Current()->platform_configuration()->client()->SendChannelUpdate(
      name, listening);
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::name, flutter::UIDartState::platform_configuration(), and flutter::PlatformConfigurationClient::SendChannelUpdate().

SendPlatformMessage()

Dart_Handle flutter::PlatformConfigurationNativeApi::SendPlatformMessage ( const std::string &  name, Dart_Handle  callback, Dart_Handle  data_handle  )

static

Definition at line 556 of file platform_configuration.cc.

                             {
  UIDartState* dart_state = UIDartState::Current();
 
  if (!dart_state->platform_configuration()) {
    return tonic::ToDart(
        "SendPlatformMessage only works on the root isolate, see "
        "SendPortPlatformMessage.");
  }
 
  fml::RefPtr<PlatformMessageResponse> response;
  if (!Dart_IsNull(callback)) {
    response = fml::MakeRefCounted<PlatformMessageResponseDart>(
        tonic::DartPersistentValue(dart_state, callback),
        dart_state->GetTaskRunners().GetUITaskRunner(), name);
  }
 
  return HandlePlatformMessage(dart_state, name, data_handle, response);
}

References callback, flutter::UIDartState::Current(), flutter::UIDartState::GetTaskRunners(), flutter::TaskRunners::GetUITaskRunner(), flutter::name, flutter::UIDartState::platform_configuration(), and tonic::ToDart().

SendPortPlatformMessage()

Dart_Handle flutter::PlatformConfigurationNativeApi::SendPortPlatformMessage ( const std::string &  name, Dart_Handle  identifier, Dart_Handle  send_port, Dart_Handle  data_handle  )

static

Definition at line 578 of file platform_configuration.cc.

                             {
  // This can be executed on any isolate.
  UIDartState* dart_state = UIDartState::Current();
 
  int64_t c_send_port = tonic::DartConverter<int64_t>::FromDart(send_port);
  if (c_send_port == ILLEGAL_PORT) {
    return tonic::ToDart("Invalid port specified");
  }
 
  fml::RefPtr<PlatformMessageResponse> response =
      fml::MakeRefCounted<PlatformMessageResponseDartPort>(
          c_send_port, tonic::DartConverter<int64_t>::FromDart(identifier),
          name);
 
  return HandlePlatformMessage(dart_state, name, data_handle, response);
}

References flutter::UIDartState::Current(), flutter::name, and tonic::ToDart().

SetApplicationLocale()

void flutter::PlatformConfigurationNativeApi::SetApplicationLocale ( std::string  locale )

static

Definition at line 680 of file platform_configuration.cc.

                                                                          {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()
      ->platform_configuration()
      ->client()
      ->SetApplicationLocale(std::move(locale));
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::UIDartState::platform_configuration(), flutter::PlatformConfigurationClient::SetApplicationLocale(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

SetIsolateDebugName()

void flutter::PlatformConfigurationNativeApi::SetIsolateDebugName ( const std::string &  name )

static

Definition at line 628 of file platform_configuration.cc.

                           {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()->SetDebugName(name);
}

References flutter::UIDartState::Current(), flutter::name, flutter::UIDartState::SetDebugName(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

SetNeedsReportTimings()

void flutter::PlatformConfigurationNativeApi::SetNeedsReportTimings ( bool  value )

static

Definition at line 529 of file platform_configuration.cc.

                                                                     {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()
      ->platform_configuration()
      ->client()
      ->SetNeedsReportTimings(value);
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::UIDartState::platform_configuration(), flutter::PlatformConfigurationClient::SetNeedsReportTimings(), flutter::UIDartState::ThrowIfUIOperationsProhibited(), and value.

SetSemanticsTreeEnabled()

void flutter::PlatformConfigurationNativeApi::SetSemanticsTreeEnabled ( bool  enabled )

static

Definition at line 688 of file platform_configuration.cc.

                                                                         {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()
      ->platform_configuration()
      ->client()
      ->SetSemanticsTreeEnabled(enabled);
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::UIDartState::platform_configuration(), flutter::PlatformConfigurationClient::SetSemanticsTreeEnabled(), and flutter::UIDartState::ThrowIfUIOperationsProhibited().

UpdateSemantics()

void flutter::PlatformConfigurationNativeApi::UpdateSemantics ( int64_t  viewId, SemanticsUpdate *  update  )

static

Definition at line 673 of file platform_configuration.cc.

                                                                              {
  UIDartState::ThrowIfUIOperationsProhibited();
  UIDartState::Current()->platform_configuration()->client()->UpdateSemantics(
      view_id, update);
}

References flutter::PlatformConfiguration::client(), flutter::UIDartState::Current(), flutter::UIDartState::platform_configuration(), flutter::UIDartState::ThrowIfUIOperationsProhibited(), flutter::PlatformConfigurationClient::UpdateSemantics(), and view_id.

---

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

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