#include <embedder_config_builder.h>

Public Types
enum class	InitializationPreference { kSnapshotsInitialize , kAOTDataInitialize , kMultiAOTInitialize , kNoInitialize }

Public Member Functions
	EmbedderConfigBuilder (EmbedderTestContext &context, InitializationPreference preference=InitializationPreference::kSnapshotsInitialize)

	~EmbedderConfigBuilder ()

FlutterProjectArgs &	GetProjectArgs ()

void	SetAssetsPath ()

void	SetSnapshots ()

void	SetAOTDataElf ()

void	SetIsolateCreateCallbackHook ()

void	SetSemanticsCallbackHooks ()

void	SetLogMessageCallbackHook ()

void	SetChannelUpdateCallbackHook ()

void	SetViewFocusChangeRequestHook ()

void	SetLogTag (std::string tag)

void	SetLocalizationCallbackHooks ()

void	SetExecutableName (std::string executable_name)

void	SetDartEntrypoint (std::string entrypoint)

void	AddCommandLineArgument (std::string arg)

void	AddDartEntrypointArgument (std::string arg)

void	SetPlatformTaskRunner (const FlutterTaskRunnerDescription *runner)

void	SetUITaskRunner (const FlutterTaskRunnerDescription *runner)

void	SetRenderTaskRunner (const FlutterTaskRunnerDescription *runner)

void	SetPlatformMessageCallback (const std::function< void(const FlutterPlatformMessage *)> &callback)

void	SetViewFocusChangeRequestCallback (const std::function< void(const FlutterViewFocusChangeRequest *)> &callback)

void	SetCompositor (bool avoid_backing_store_cache=false, bool use_present_layers_callback=false)

FlutterCompositor &	GetCompositor ()

void	SetSurface (DlISize surface_size)

void	SetRenderTargetType (EmbedderTestBackingStoreProducer::RenderTargetType type, FlutterSoftwarePixelFormat software_pixfmt=kFlutterSoftwarePixelFormatNative32)

UniqueEngine	LaunchEngine () const

UniqueEngine	InitializeEngine () const

void	SetupVsyncCallback ()

void	SetViewFocusChangeRequestCallback (const FlutterViewFocusChangeRequestCallback &callback)

Detailed Description

Definition at line 29 of file embedder_config_builder.h.

Member Enumeration Documentation

◆ InitializationPreference

enum class flutter::testing::EmbedderConfigBuilder::InitializationPreference

strong

Enumerator
kSnapshotsInitialize
kAOTDataInitialize
kMultiAOTInitialize
kNoInitialize

Definition at line 31 of file embedder_config_builder.h.

                                      {
    kSnapshotsInitialize,
    kAOTDataInitialize,
    kMultiAOTInitialize,
    kNoInitialize,
  };

Constructor & Destructor Documentation

◆ EmbedderConfigBuilder()

flutter::testing::EmbedderConfigBuilder::EmbedderConfigBuilder	(	EmbedderTestContext &	context,
		InitializationPreference	preference = `InitializationPreference::kSnapshotsInitialize`
	)

explicit

Definition at line 15 of file embedder_config_builder.cc.

    : context_(context) {
  project_args_.struct_size = sizeof(project_args_);
  project_args_.shutdown_dart_vm_when_done = true;
  project_args_.platform_message_callback =
      [](const FlutterPlatformMessage* message, void* context) {
        reinterpret_cast<EmbedderTestContext*>(context)
            ->PlatformMessageCallback(message);
      };
 
  custom_task_runners_.struct_size = sizeof(FlutterCustomTaskRunners);
 
  // The first argument is always the executable name. Don't make tests have to
  // do this manually.
  AddCommandLineArgument("embedder_unittest");
 
  if (preference != InitializationPreference::kNoInitialize) {
    SetAssetsPath();
    SetIsolateCreateCallbackHook();
    SetSemanticsCallbackHooks();
    SetLogMessageCallbackHook();
    SetLocalizationCallbackHooks();
    SetChannelUpdateCallbackHook();
    SetViewFocusChangeRequestHook();
    AddCommandLineArgument("--disable-vm-service");
 
    if (preference == InitializationPreference::kSnapshotsInitialize ||
        preference == InitializationPreference::kMultiAOTInitialize) {
      SetSnapshots();
    }
    if (preference == InitializationPreference::kAOTDataInitialize ||
        preference == InitializationPreference::kMultiAOTInitialize) {
      SetAOTDataElf();
    }
  }
}

References AddCommandLineArgument(), kAOTDataInitialize, kMultiAOTInitialize, kNoInitialize, kSnapshotsInitialize, message, FlutterProjectArgs::platform_message_callback, SetAOTDataElf(), SetAssetsPath(), SetChannelUpdateCallbackHook(), SetIsolateCreateCallbackHook(), SetLocalizationCallbackHooks(), SetLogMessageCallbackHook(), SetSemanticsCallbackHooks(), SetSnapshots(), SetViewFocusChangeRequestHook(), FlutterProjectArgs::shutdown_dart_vm_when_done, FlutterCustomTaskRunners::struct_size, and FlutterProjectArgs::struct_size.

◆ ~EmbedderConfigBuilder()

flutter::testing::EmbedderConfigBuilder::~EmbedderConfigBuilder ( )

default

Member Function Documentation

◆ AddCommandLineArgument()

void flutter::testing::EmbedderConfigBuilder::AddCommandLineArgument ( std::string arg )

Definition at line 147 of file embedder_config_builder.cc.

                                                                {
  if (arg.empty()) {
    return;
  }
 
  command_line_arguments_.emplace_back(std::move(arg));
}

Referenced by EmbedderConfigBuilder(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ AddDartEntrypointArgument()

void flutter::testing::EmbedderConfigBuilder::AddDartEntrypointArgument ( std::string arg )

Definition at line 155 of file embedder_config_builder.cc.

                                                                   {
  if (arg.empty()) {
    return;
  }
 
  dart_entrypoint_arguments_.emplace_back(std::move(arg));
}

Referenced by flutter::testing::TEST_F().

◆ GetCompositor()

FlutterCompositor & flutter::testing::EmbedderConfigBuilder::GetCompositor ( )

Definition at line 252 of file embedder_config_builder.cc.

                                                        {
  return compositor_;
}

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ GetProjectArgs()

FlutterProjectArgs & flutter::testing::EmbedderConfigBuilder::GetProjectArgs ( )

Definition at line 56 of file embedder_config_builder.cc.

                                                          {
  return project_args_;
}

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ InitializeEngine()

UniqueEngine flutter::testing::EmbedderConfigBuilder::InitializeEngine ( ) const

Definition at line 266 of file embedder_config_builder.cc.

                                                           {
  return SetupEngine(false);
}

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_P().

◆ LaunchEngine()

UniqueEngine flutter::testing::EmbedderConfigBuilder::LaunchEngine ( ) const

Definition at line 262 of file embedder_config_builder.cc.

                                                       {
  return SetupEngine(true);
}

◆ SetAOTDataElf()

void flutter::testing::EmbedderConfigBuilder::SetAOTDataElf ( )

Definition at line 86 of file embedder_config_builder.cc.

                                          {
  project_args_.aot_data = context_.GetAOTData();
}

References FlutterProjectArgs::aot_data, and flutter::testing::EmbedderTestContext::GetAOTData().

Referenced by EmbedderConfigBuilder().

◆ SetAssetsPath()

void flutter::testing::EmbedderConfigBuilder::SetAssetsPath ( )

Definition at line 60 of file embedder_config_builder.cc.

                                          {
  project_args_.assets_path = context_.GetAssetsPath().c_str();
}

References FlutterProjectArgs::assets_path, and flutter::testing::EmbedderTestContext::GetAssetsPath().

Referenced by EmbedderConfigBuilder().

◆ SetChannelUpdateCallbackHook()

void flutter::testing::EmbedderConfigBuilder::SetChannelUpdateCallbackHook ( )

Definition at line 111 of file embedder_config_builder.cc.

                                                         {
  project_args_.channel_update_callback =
      context_.GetChannelUpdateCallbackHook();
}

References FlutterProjectArgs::channel_update_callback, and flutter::testing::EmbedderTestContext::GetChannelUpdateCallbackHook().

Referenced by EmbedderConfigBuilder().

◆ SetCompositor()

void flutter::testing::EmbedderConfigBuilder::SetCompositor	(	bool	avoid_backing_store_cache = `false`,
		bool	use_present_layers_callback = `false`
	)

Definition at line 208 of file embedder_config_builder.cc.

                                                                            {
  context_.SetupCompositor();
  auto& compositor = context_.GetCompositor();
  compositor_.struct_size = sizeof(compositor_);
  compositor_.user_data = &compositor;
  compositor_.create_backing_store_callback =
      [](const FlutterBackingStoreConfig* config,  //
         FlutterBackingStore* backing_store_out,   //
         void* user_data                           //
      ) {
        return reinterpret_cast<EmbedderTestCompositor*>(user_data)
            ->CreateBackingStore(config, backing_store_out);
      };
  compositor_.collect_backing_store_callback =
      [](const FlutterBackingStore* backing_store,  //
         void* user_data                            //
      ) {
        return reinterpret_cast<EmbedderTestCompositor*>(user_data)
            ->CollectBackingStore(backing_store);
      };
  if (use_present_layers_callback) {
    compositor_.present_layers_callback = [](const FlutterLayer** layers,
                                             size_t layers_count,
                                             void* user_data) {
      auto compositor = reinterpret_cast<EmbedderTestCompositor*>(user_data);
 
      // The present layers callback is incompatible with multiple views;
      // it can only be used to render the implicit view.
      return compositor->Present(kFlutterImplicitViewId, layers, layers_count);
    };
  } else {
    compositor_.present_view_callback = [](const FlutterPresentViewInfo* info) {
      auto compositor =
          reinterpret_cast<EmbedderTestCompositor*>(info->user_data);
 
      return compositor->Present(info->view_id, info->layers,
                                 info->layers_count);
    };
  }
  compositor_.avoid_backing_store_cache = avoid_backing_store_cache;
  project_args_.compositor = &compositor_;
}

References FlutterProjectArgs::compositor, flutter::testing::EmbedderTestContext::GetCompositor(), flutter::kFlutterImplicitViewId, layers, layers_count, flutter::testing::EmbedderTestCompositor::Present(), flutter::testing::EmbedderTestContext::SetupCompositor(), and user_data.

◆ SetDartEntrypoint()

void flutter::testing::EmbedderConfigBuilder::SetDartEntrypoint ( std::string entrypoint )

Definition at line 138 of file embedder_config_builder.cc.

                                                                  {
  if (entrypoint.empty()) {
    return;
  }
 
  dart_entrypoint_ = std::move(entrypoint);
  project_args_.custom_dart_entrypoint = dart_entrypoint_.c_str();
}

References FlutterProjectArgs::custom_dart_entrypoint.

◆ SetExecutableName()

void flutter::testing::EmbedderConfigBuilder::SetExecutableName ( std::string executable_name )

Definition at line 131 of file embedder_config_builder.cc.

                                                                       {
  if (executable_name.empty()) {
    return;
  }
  command_line_arguments_[0] = std::move(executable_name);
}

Referenced by flutter::testing::TEST_F().

◆ SetIsolateCreateCallbackHook()

void flutter::testing::EmbedderConfigBuilder::SetIsolateCreateCallbackHook ( )

Definition at line 90 of file embedder_config_builder.cc.

                                                         {
  project_args_.root_isolate_create_callback =
      EmbedderTestContext::GetIsolateCreateCallbackHook();
}

References flutter::testing::EmbedderTestContext::GetIsolateCreateCallbackHook(), and FlutterProjectArgs::root_isolate_create_callback.

Referenced by EmbedderConfigBuilder().

◆ SetLocalizationCallbackHooks()

void flutter::testing::EmbedderConfigBuilder::SetLocalizationCallbackHooks ( )

Definition at line 126 of file embedder_config_builder.cc.

                                                         {
  project_args_.compute_platform_resolved_locale_callback =
      EmbedderTestContext::GetComputePlatformResolvedLocaleCallbackHook();
}

References FlutterProjectArgs::compute_platform_resolved_locale_callback, and flutter::testing::EmbedderTestContext::GetComputePlatformResolvedLocaleCallbackHook().

Referenced by EmbedderConfigBuilder().

◆ SetLogMessageCallbackHook()

void flutter::testing::EmbedderConfigBuilder::SetLogMessageCallbackHook ( )

Definition at line 106 of file embedder_config_builder.cc.

                                                      {
  project_args_.log_message_callback =
      EmbedderTestContext::GetLogMessageCallbackHook();
}

References flutter::testing::EmbedderTestContext::GetLogMessageCallbackHook(), and FlutterProjectArgs::log_message_callback.

Referenced by EmbedderConfigBuilder().

◆ SetLogTag()

void flutter::testing::EmbedderConfigBuilder::SetLogTag ( std::string tag )

Definition at line 121 of file embedder_config_builder.cc.

                                                   {
  log_tag_ = std::move(tag);
  project_args_.log_tag = log_tag_.c_str();
}

References FlutterProjectArgs::log_tag.

Referenced by flutter::testing::TEST_F().

◆ SetPlatformMessageCallback()

void flutter::testing::EmbedderConfigBuilder::SetPlatformMessageCallback ( const std::function< void(const FlutterPlatformMessage *)> & callback )

Definition at line 198 of file embedder_config_builder.cc.

                                                                      {
  context_.SetPlatformMessageCallback(callback);
}

References callback, and flutter::testing::EmbedderTestContext::SetPlatformMessageCallback().

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ SetPlatformTaskRunner()

void flutter::testing::EmbedderConfigBuilder::SetPlatformTaskRunner ( const FlutterTaskRunnerDescription * runner )

Definition at line 163 of file embedder_config_builder.cc.

                                                {
  if (runner == nullptr) {
    return;
  }
  custom_task_runners_.platform_task_runner = runner;
  project_args_.custom_task_runners = &custom_task_runners_;
}

References FlutterProjectArgs::custom_task_runners, and FlutterCustomTaskRunners::platform_task_runner.

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_P().

◆ SetRenderTargetType()

void flutter::testing::EmbedderConfigBuilder::SetRenderTargetType	(	EmbedderTestBackingStoreProducer::RenderTargetType	type,
		FlutterSoftwarePixelFormat	software_pixfmt = `kFlutterSoftwarePixelFormatNative32`
	)

Definition at line 256 of file embedder_config_builder.cc.

                                                {
  context_.GetCompositor().SetRenderTargetType(type, software_pixfmt);
}

References flutter::testing::EmbedderTestContext::GetCompositor(), flutter::testing::EmbedderTestCompositor::SetRenderTargetType(), and type.

◆ SetRenderTaskRunner()

void flutter::testing::EmbedderConfigBuilder::SetRenderTaskRunner ( const FlutterTaskRunnerDescription * runner )

Definition at line 188 of file embedder_config_builder.cc.

                                                {
  if (runner == nullptr) {
    return;
  }
 
  custom_task_runners_.render_task_runner = runner;
  project_args_.custom_task_runners = &custom_task_runners_;
}

References FlutterProjectArgs::custom_task_runners, and FlutterCustomTaskRunners::render_task_runner.

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_P().

◆ SetSemanticsCallbackHooks()

void flutter::testing::EmbedderConfigBuilder::SetSemanticsCallbackHooks ( )

Definition at line 95 of file embedder_config_builder.cc.

                                                      {
  project_args_.update_semantics_callback2 =
      context_.GetUpdateSemanticsCallback2Hook();
  project_args_.update_semantics_callback =
      context_.GetUpdateSemanticsCallbackHook();
  project_args_.update_semantics_node_callback =
      context_.GetUpdateSemanticsNodeCallbackHook();
  project_args_.update_semantics_custom_action_callback =
      context_.GetUpdateSemanticsCustomActionCallbackHook();
}

References flutter::testing::EmbedderTestContext::GetUpdateSemanticsCallback2Hook(), flutter::testing::EmbedderTestContext::GetUpdateSemanticsCallbackHook(), flutter::testing::EmbedderTestContext::GetUpdateSemanticsCustomActionCallbackHook(), flutter::testing::EmbedderTestContext::GetUpdateSemanticsNodeCallbackHook(), FlutterProjectArgs::update_semantics_callback, FlutterProjectArgs::update_semantics_callback2, FlutterProjectArgs::update_semantics_custom_action_callback, and FlutterProjectArgs::update_semantics_node_callback.

Referenced by EmbedderConfigBuilder().

◆ SetSnapshots()

void flutter::testing::EmbedderConfigBuilder::SetSnapshots ( )

Definition at line 64 of file embedder_config_builder.cc.

                                         {
  if (auto mapping = context_.GetVMSnapshotData()) {
    project_args_.vm_snapshot_data = mapping->GetMapping();
    project_args_.vm_snapshot_data_size = mapping->GetSize();
  }
 
  if (auto mapping = context_.GetVMSnapshotInstructions()) {
    project_args_.vm_snapshot_instructions = mapping->GetMapping();
    project_args_.vm_snapshot_instructions_size = mapping->GetSize();
  }
 
  if (auto mapping = context_.GetIsolateSnapshotData()) {
    project_args_.isolate_snapshot_data = mapping->GetMapping();
    project_args_.isolate_snapshot_data_size = mapping->GetSize();
  }
 
  if (auto mapping = context_.GetIsolateSnapshotInstructions()) {
    project_args_.isolate_snapshot_instructions = mapping->GetMapping();
    project_args_.isolate_snapshot_instructions_size = mapping->GetSize();
  }
}

Referenced by EmbedderConfigBuilder().

◆ SetSurface()

void flutter::testing::EmbedderConfigBuilder::SetSurface ( DlISize surface_size )

inline

Definition at line 95 of file embedder_config_builder.h.

95{ context_.SetSurface(surface_size); }

flutter::testing::EmbedderTestContext::SetSurface

virtual void SetSurface(DlISize surface_size)=0

References flutter::testing::EmbedderTestContext::SetSurface().

◆ SetUITaskRunner()

void flutter::testing::EmbedderConfigBuilder::SetUITaskRunner ( const FlutterTaskRunnerDescription * runner )

Definition at line 172 of file embedder_config_builder.cc.

                                                {
  if (runner == nullptr) {
    return;
  }
  custom_task_runners_.ui_task_runner = runner;
  project_args_.custom_task_runners = &custom_task_runners_;
}

References FlutterProjectArgs::custom_task_runners, and FlutterCustomTaskRunners::ui_task_runner.

Referenced by flutter::testing::TEST_F(), flutter::testing::TEST_F(), flutter::testing::TEST_F(), and flutter::testing::TEST_F().

◆ SetupVsyncCallback()

void flutter::testing::EmbedderConfigBuilder::SetupVsyncCallback ( )

Definition at line 181 of file embedder_config_builder.cc.

                                               {
  project_args_.vsync_callback = [](void* user_data, intptr_t baton) {
    auto context = reinterpret_cast<EmbedderTestContext*>(user_data);
    context->RunVsyncCallback(baton);
  };
}

References flutter::testing::EmbedderTestContext::RunVsyncCallback(), user_data, and FlutterProjectArgs::vsync_callback.

Referenced by flutter::testing::TEST_F().

◆ SetViewFocusChangeRequestCallback() [1/2]

void flutter::testing::EmbedderConfigBuilder::SetViewFocusChangeRequestCallback ( const FlutterViewFocusChangeRequestCallback & callback )

◆ SetViewFocusChangeRequestCallback() [2/2]

void flutter::testing::EmbedderConfigBuilder::SetViewFocusChangeRequestCallback ( const std::function< void(const FlutterViewFocusChangeRequest *)> & callback )

Definition at line 203 of file embedder_config_builder.cc.

                                                                             {
  context_.SetViewFocusChangeRequestCallback(callback);
}

References callback, and flutter::testing::EmbedderTestContext::SetViewFocusChangeRequestCallback().

Referenced by flutter::testing::TEST_F().

◆ SetViewFocusChangeRequestHook()

void flutter::testing::EmbedderConfigBuilder::SetViewFocusChangeRequestHook ( )

Definition at line 116 of file embedder_config_builder.cc.

                                                          {
  project_args_.view_focus_change_request_callback =
      context_.GetViewFocusChangeRequestCallbackHook();
}

References flutter::testing::EmbedderTestContext::GetViewFocusChangeRequestCallbackHook(), and FlutterProjectArgs::view_focus_change_request_callback.

Referenced by EmbedderConfigBuilder().

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

shell/platform/embedder/tests/embedder_config_builder.h
shell/platform/embedder/tests/embedder_config_builder.cc

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ InitializationPreference

Constructor & Destructor Documentation

◆ EmbedderConfigBuilder()

◆ ~EmbedderConfigBuilder()

Member Function Documentation

◆ AddCommandLineArgument()

◆ AddDartEntrypointArgument()

◆ GetCompositor()

◆ GetProjectArgs()

◆ InitializeEngine()

◆ LaunchEngine()

◆ SetAOTDataElf()

◆ SetAssetsPath()

◆ SetChannelUpdateCallbackHook()

◆ SetCompositor()

◆ SetDartEntrypoint()

◆ SetExecutableName()

◆ SetIsolateCreateCallbackHook()

◆ SetLocalizationCallbackHooks()

◆ SetLogMessageCallbackHook()

◆ SetLogTag()

◆ SetPlatformMessageCallback()

◆ SetPlatformTaskRunner()

◆ SetRenderTargetType()

◆ SetRenderTaskRunner()

◆ SetSemanticsCallbackHooks()

◆ SetSnapshots()

◆ SetSurface()

◆ SetUITaskRunner()

◆ SetupVsyncCallback()

◆ SetViewFocusChangeRequestCallback() [1/2]

◆ SetViewFocusChangeRequestCallback() [2/2]

◆ SetViewFocusChangeRequestHook()