flutter::testing::WindowsConfigBuilder Class Reference

#include <windows_test_config_builder.h>

Public Member Functions
	WindowsConfigBuilder (WindowsTestContext &context)
	~WindowsConfigBuilder ()
FlutterDesktopEngineProperties	GetEngineProperties () const
void	SetDartEntrypoint (std::string_view entrypoint)
void	SetUIThreadPolicy (FlutterDesktopUIThreadPolicy policy)
void	AddDartEntrypointArgument (std::string_view arg)
void	SetGpuPreference (FlutterDesktopGpuPreference gpu_preference)
EnginePtr	InitializeEngine () const
EnginePtr	RunHeadless () const
ViewControllerPtr	Run () const

Detailed Description

Definition at line 47 of file windows_test_config_builder.h.

Constructor & Destructor Documentation

WindowsConfigBuilder()

flutter::testing::WindowsConfigBuilder::WindowsConfigBuilder ( WindowsTestContext &  context )

explicit

Definition at line 21 of file windows_test_config_builder.cc.

    : context_(context) {}

~WindowsConfigBuilder()

flutter::testing::WindowsConfigBuilder::~WindowsConfigBuilder ( )

default

Member Function Documentation

AddDartEntrypointArgument()

void flutter::testing::WindowsConfigBuilder::AddDartEntrypointArgument

(

std::string_view

arg

)

Definition at line 38 of file windows_test_config_builder.cc.

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

GetEngineProperties()

FlutterDesktopEngineProperties flutter::testing::WindowsConfigBuilder::GetEngineProperties

(

)

const

Definition at line 51 of file windows_test_config_builder.cc.

          {
  FlutterDesktopEngineProperties engine_properties = {};
  engine_properties.assets_path = context_.GetAssetsPath().c_str();
  engine_properties.icu_data_path = context_.GetIcuDataPath().c_str();
 
  // Set Dart entrypoint.
  engine_properties.dart_entrypoint = dart_entrypoint_.c_str();
 
  // Set Dart entrypoint argc, argv.
  std::vector<const char*> dart_args;
  dart_args.reserve(dart_entrypoint_arguments_.size());
  for (const auto& arg : dart_entrypoint_arguments_) {
    dart_args.push_back(arg.c_str());
  }
  if (!dart_args.empty()) {
    engine_properties.dart_entrypoint_argv = dart_args.data();
    engine_properties.dart_entrypoint_argc = dart_args.size();
  } else {
    // Clear this out in case this is not the first engine launch from the
    // embedder config builder.
    engine_properties.dart_entrypoint_argv = nullptr;
    engine_properties.dart_entrypoint_argc = 0;
  }
 
  engine_properties.gpu_preference = gpu_preference_;
  engine_properties.ui_thread_policy = ui_thread_policy_;
 
  return engine_properties;
}

References FlutterDesktopEngineProperties::assets_path, FlutterDesktopEngineProperties::dart_entrypoint, FlutterDesktopEngineProperties::dart_entrypoint_argc, FlutterDesktopEngineProperties::dart_entrypoint_argv, flutter::testing::WindowsTestContext::GetAssetsPath(), flutter::testing::WindowsTestContext::GetIcuDataPath(), FlutterDesktopEngineProperties::gpu_preference, FlutterDesktopEngineProperties::icu_data_path, and FlutterDesktopEngineProperties::ui_thread_policy.

Referenced by InitializeEngine().

InitializeEngine()

EnginePtr flutter::testing::WindowsConfigBuilder::InitializeEngine

(

)

const

Definition at line 82 of file windows_test_config_builder.cc.

                                                       {
  FlutterDesktopEngineProperties engine_properties = GetEngineProperties();
  return EnginePtr{FlutterDesktopEngineCreate(&engine_properties)};
}

References FlutterDesktopEngineCreate(), and GetEngineProperties().

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

Run()

ViewControllerPtr flutter::testing::WindowsConfigBuilder::Run

(

)

const

Definition at line 108 of file windows_test_config_builder.cc.

                                                  {
  InitializeCOM();
 
  EnginePtr engine = InitializeEngine();
  if (!engine) {
    return {};
  }
 
  // Register native functions.
  FlutterWindowsEngine* windows_engine =
      reinterpret_cast<FlutterWindowsEngine*>(engine.get());
  windows_engine->SetRootIsolateCreateCallback(
      context_.GetRootIsolateCallback());
 
  int width = 600;
  int height = 400;
 
  // Create a view controller that owns the engine.
  ViewControllerPtr controller{
      FlutterDesktopViewControllerCreate(width, height, engine.release())};
  if (!controller) {
    return {};
  }
 
  return controller;
}

References engine, FlutterDesktopViewControllerCreate(), flutter::testing::WindowsTestContext::GetRootIsolateCallback(), height, InitializeEngine(), flutter::FlutterWindowsEngine::SetRootIsolateCreateCallback(), and width.

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(), 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_F().

RunHeadless()

EnginePtr flutter::testing::WindowsConfigBuilder::RunHeadless

(

)

const

Definition at line 87 of file windows_test_config_builder.cc.

                                                  {
  InitializeCOM();
 
  EnginePtr engine = InitializeEngine();
  if (!engine) {
    return {};
  }
 
  // Register native functions.
  FlutterWindowsEngine* windows_engine =
      reinterpret_cast<FlutterWindowsEngine*>(engine.get());
  windows_engine->SetRootIsolateCreateCallback(
      context_.GetRootIsolateCallback());
 
  if (!FlutterDesktopEngineRun(engine.get(), /* entry_point */ nullptr)) {
    return {};
  }
 
  return engine;
}

References engine, FlutterDesktopEngineRun(), flutter::testing::WindowsTestContext::GetRootIsolateCallback(), InitializeEngine(), and flutter::FlutterWindowsEngine::SetRootIsolateCreateCallback().

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

SetDartEntrypoint()

void flutter::testing::WindowsConfigBuilder::SetDartEntrypoint

(

std::string_view

entrypoint

)

Definition at line 26 of file windows_test_config_builder.cc.

                                                                      {
  if (entrypoint.empty()) {
    return;
  }
  dart_entrypoint_ = entrypoint;
}

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(), 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_F().

SetGpuPreference()

void flutter::testing::WindowsConfigBuilder::SetGpuPreference

(

FlutterDesktopGpuPreference

gpu_preference

)

Definition at line 46 of file windows_test_config_builder.cc.

                                                {
  gpu_preference_ = gpu_preference;
}

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

SetUIThreadPolicy()

void flutter::testing::WindowsConfigBuilder::SetUIThreadPolicy

(

FlutterDesktopUIThreadPolicy

policy

)

Definition at line 33 of file windows_test_config_builder.cc.

                                         {
  ui_thread_policy_ = policy;
}

References flutter::policy.

---

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

• shell/platform/windows/testing/windows_test_config_builder.h
• shell/platform/windows/testing/windows_test_config_builder.cc