flutter::FlutterProjectBundle Class Reference

#include <flutter_project_bundle.h>

Public Member Functions
	FlutterProjectBundle (const FlutterDesktopEngineProperties &properties)
	~FlutterProjectBundle ()
bool	HasValidPaths ()
const std::filesystem::path &	assets_path ()
const std::filesystem::path &	icu_path ()
const std::vector< std::string >	GetSwitches ()
void	SetSwitches (const std::vector< std::string > &switches)
UniqueAotDataPtr	LoadAotData (const FlutterEngineProcTable &engine_procs)
const std::string &	dart_entrypoint () const
const std::vector< std::string > &	dart_entrypoint_arguments () const
FlutterGpuPreference	gpu_preference () const
FlutterUIThreadPolicy	ui_thread_policy ()
FlutterAccessibilityMode	accessibility_mode () const
FlutterImpellerSwitch	impeller_switch () const

Detailed Description

Definition at line 45 of file flutter_project_bundle.h.

Constructor & Destructor Documentation

FlutterProjectBundle()

flutter::FlutterProjectBundle::FlutterProjectBundle ( const FlutterDesktopEngineProperties &  properties )

explicit

Definition at line 16 of file flutter_project_bundle.cc.

    : assets_path_(properties.assets_path),
      icu_path_(properties.icu_data_path) {
  if (properties.aot_library_path != nullptr) {
    aot_library_path_ = std::filesystem::path(properties.aot_library_path);
  }
 
  if (properties.dart_entrypoint && properties.dart_entrypoint[0] != '\0') {
    dart_entrypoint_ = properties.dart_entrypoint;
  }
 
  for (int i = 0; i < properties.dart_entrypoint_argc; i++) {
    dart_entrypoint_arguments_.push_back(
        std::string(properties.dart_entrypoint_argv[i]));
  }
 
  gpu_preference_ =
      static_cast<FlutterGpuPreference>(properties.gpu_preference);
 
  ui_thread_policy_ =
      static_cast<FlutterUIThreadPolicy>(properties.ui_thread_policy);
 
  accessibility_mode_ =
      static_cast<FlutterAccessibilityMode>(properties.accessibility_mode);
 
  impeller_switch_ =
      static_cast<FlutterImpellerSwitch>(properties.impeller_switch);
 
  // Resolve any relative paths.
  if (assets_path_.is_relative() || icu_path_.is_relative() ||
      (!aot_library_path_.empty() && aot_library_path_.is_relative())) {
    std::filesystem::path executable_location = GetExecutableDirectory();
    if (executable_location.empty()) {
      FML_LOG(ERROR)
          << "Unable to find executable location to resolve resource paths.";
      assets_path_ = std::filesystem::path();
      icu_path_ = std::filesystem::path();
    } else {
      assets_path_ = std::filesystem::path(executable_location) / assets_path_;
      icu_path_ = std::filesystem::path(executable_location) / icu_path_;
      if (!aot_library_path_.empty()) {
        aot_library_path_ =
            std::filesystem::path(executable_location) / aot_library_path_;
      }
    }
  }
}

References FlutterDesktopEngineProperties::accessibility_mode, FlutterDesktopEngineProperties::aot_library_path, FlutterDesktopEngineProperties::dart_entrypoint, FlutterDesktopEngineProperties::dart_entrypoint_argc, FlutterDesktopEngineProperties::dart_entrypoint_argv, FML_LOG, flutter::GetExecutableDirectory(), FlutterDesktopEngineProperties::gpu_preference, i, FlutterDesktopEngineProperties::impeller_switch, and FlutterDesktopEngineProperties::ui_thread_policy.

~FlutterProjectBundle()

flutter::FlutterProjectBundle::~FlutterProjectBundle

(

)

Definition at line 96 of file flutter_project_bundle.cc.

{}

Member Function Documentation

accessibility_mode()

FlutterAccessibilityMode flutter::FlutterProjectBundle::accessibility_mode ( ) const

inline

Definition at line 93 of file flutter_project_bundle.h.

                                                      {
    return accessibility_mode_;
  }

assets_path()

const std::filesystem::path & flutter::FlutterProjectBundle::assets_path ( )

inline

Definition at line 60 of file flutter_project_bundle.h.

{ return assets_path_; }

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

dart_entrypoint()

const std::string & flutter::FlutterProjectBundle::dart_entrypoint ( ) const

inline

Definition at line 78 of file flutter_project_bundle.h.

{ return dart_entrypoint_; }

dart_entrypoint_arguments()

const std::vector< std::string > & flutter::FlutterProjectBundle::dart_entrypoint_arguments ( ) const

inline

Definition at line 82 of file flutter_project_bundle.h.

                                                                {
    return dart_entrypoint_arguments_;
  }

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

GetSwitches()

const std::vector< std::string > flutter::FlutterProjectBundle::GetSwitches

(

)

Definition at line 103 of file flutter_project_bundle.cc.

                                                             {
  if (engine_switches_.size() == 0) {
    return GetSwitchesFromEnvironment();
  }
  std::vector<std::string> switches;
  switches.insert(switches.end(), engine_switches_.begin(),
                  engine_switches_.end());
 
  auto env_switches = GetSwitchesFromEnvironment();
  switches.insert(switches.end(), env_switches.begin(), env_switches.end());
 
  return switches;
}

References flutter::GetSwitchesFromEnvironment().

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

gpu_preference()

FlutterGpuPreference flutter::FlutterProjectBundle::gpu_preference ( ) const

inline

Definition at line 87 of file flutter_project_bundle.h.

{ return gpu_preference_; }

HasValidPaths()

bool flutter::FlutterProjectBundle::HasValidPaths

(

)

Definition at line 65 of file flutter_project_bundle.cc.

                                         {
  return !assets_path_.empty() && !icu_path_.empty();
}

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

icu_path()

const std::filesystem::path & flutter::FlutterProjectBundle::icu_path ( )

inline

Definition at line 63 of file flutter_project_bundle.h.

{ return icu_path_; }

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

impeller_switch()

FlutterImpellerSwitch flutter::FlutterProjectBundle::impeller_switch ( ) const

inline

Definition at line 98 of file flutter_project_bundle.h.

{ return impeller_switch_; }

LoadAotData()

UniqueAotDataPtr flutter::FlutterProjectBundle::LoadAotData

(

const FlutterEngineProcTable &

engine_procs

)

Definition at line 71 of file flutter_project_bundle.cc.

                                                {
  if (aot_library_path_.empty()) {
    FML_LOG(ERROR)
        << "Attempted to load AOT data, but no aot_library_path was provided.";
    return UniqueAotDataPtr(nullptr, nullptr);
  }
  if (!std::filesystem::exists(aot_library_path_)) {
    FML_LOG(ERROR) << "Can't load AOT data from " << aot_library_path_
                   << "; no such file.";
    return UniqueAotDataPtr(nullptr, nullptr);
  }
  std::string path_string = fml::PathToUtf8(aot_library_path_);
  FlutterEngineAOTDataSource source = {};
  source.type = kFlutterEngineAOTDataSourceTypeElfPath;
  source.elf_path = path_string.c_str();
  FlutterEngineAOTData data = nullptr;
  auto result = engine_procs.CreateAOTData(&source, &data);
  if (result != kSuccess) {
    FML_LOG(ERROR) << "Failed to load AOT data from: " << path_string;
    return UniqueAotDataPtr(nullptr, nullptr);
  }
  return UniqueAotDataPtr(data, engine_procs.CollectAOTData);
}

References FlutterEngineProcTable::CollectAOTData, FlutterEngineProcTable::CreateAOTData, flutter::data, FlutterEngineAOTDataSource::elf_path, FML_LOG, kFlutterEngineAOTDataSourceTypeElfPath, flutter::kSuccess, fml::PathToUtf8(), and FlutterEngineAOTDataSource::type.

SetSwitches()

void flutter::FlutterProjectBundle::SetSwitches

(

const std::vector< std::string > &

switches

)

Definition at line 98 of file flutter_project_bundle.cc.

                                          {
  engine_switches_ = switches;
}

Referenced by flutter::testing::FlutterWindowsEngineBuilder::Build().

ui_thread_policy()

FlutterUIThreadPolicy flutter::FlutterProjectBundle::ui_thread_policy ( )

inline

Definition at line 90 of file flutter_project_bundle.h.

{ return ui_thread_policy_; }

---

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

• shell/platform/windows/flutter_project_bundle.h
• shell/platform/windows/flutter_project_bundle.cc