Flutter Linux Embedder
Enumerations | Functions
fl_dart_project.h File Reference
#include <glib-object.h>
#include <gmodule.h>

Go to the source code of this file.

Enumerations

enum  FlUIThreadPolicy {
  FL_UI_THREAD_POLICY_DEFAULT ,
  FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD ,
  FL_UI_THREAD_POLICY_RUN_ON_SEPARATE_THREAD
}
 

Functions

G_BEGIN_DECLS G_MODULE_EXPORT FlDartProject * fl_dart_project_new ()
 
void fl_dart_project_set_aot_library_path (FlDartProject *project, const gchar *path)
 
const gchar * fl_dart_project_get_aot_library_path (FlDartProject *project)
 
void fl_dart_project_set_assets_path (FlDartProject *project, gchar *path)
 
const gchar * fl_dart_project_get_assets_path (FlDartProject *project)
 
void fl_dart_project_set_icu_data_path (FlDartProject *project, gchar *path)
 
const gchar * fl_dart_project_get_icu_data_path (FlDartProject *project)
 
void fl_dart_project_set_dart_entrypoint_arguments (FlDartProject *project, char **argv)
 
gchar ** fl_dart_project_get_dart_entrypoint_arguments (FlDartProject *project)
 
void fl_dart_project_set_ui_thread_policy (FlDartProject *project, FlUIThreadPolicy policy)
 
FlUIThreadPolicy fl_dart_project_get_ui_thread_policy (FlDartProject *project)
 
void fl_dart_project_set_enable_impeller (FlDartProject *project, gboolean enable_impeller)
 
gboolean fl_dart_project_get_enable_impeller (FlDartProject *project)
 
void fl_dart_project_set_enable_flutter_gpu (FlDartProject *project, gboolean enable_flutter_gpu)
 
gboolean fl_dart_project_get_enable_flutter_gpu (FlDartProject *project)
 

Enumeration Type Documentation

◆ FlUIThreadPolicy

enum FlUIThreadPolicy

FlUIThreadPolicy: Configures the thread policy for running the UI isolate. @FL_UI_THREAD_POLICY_DEFAULT: Defaut value. Currently will run the UI isolate on separate thread, later will change to run on platform thread. @FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD: Run the UI isolate on the platform thread. @FL_UI_THREAD_POLICY_RUN_ON_SEPARATE_THREAD: Run the UI isolate on a separate thread.

Enumerator
FL_UI_THREAD_POLICY_DEFAULT 
FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD 
FL_UI_THREAD_POLICY_RUN_ON_SEPARATE_THREAD 

Definition at line 141 of file fl_dart_project.h.

141  {
142  FL_UI_THREAD_POLICY_DEFAULT,
143  FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD,
144  FL_UI_THREAD_POLICY_RUN_ON_SEPARATE_THREAD,
145 } FlUIThreadPolicy;
FlUIThreadPolicy
FlUIThreadPolicy
Definition: fl_dart_project.h:141
FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD
@ FL_UI_THREAD_POLICY_RUN_ON_PLATFORM_THREAD
Definition: fl_dart_project.h:143
FL_UI_THREAD_POLICY_RUN_ON_SEPARATE_THREAD
@ FL_UI_THREAD_POLICY_RUN_ON_SEPARATE_THREAD
Definition: fl_dart_project.h:144
FL_UI_THREAD_POLICY_DEFAULT
@ FL_UI_THREAD_POLICY_DEFAULT
Definition: fl_dart_project.h:142

Function Documentation

◆ fl_dart_project_get_aot_library_path()

const gchar* fl_dart_project_get_aot_library_path ( FlDartProject *  project)

fl_dart_project_get_aot_library_path: @project: an #FlDartProject.

Gets the path to the AOT library in the Flutter application.

Returns: (type filename): an absolute file path, e.g. "/projects/my_dart_project/lib/libapp.so".

Definition at line 77 of file fl_dart_project.cc.

78  {
79  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
80  return self->aot_library_path;
81 }

Referenced by fl_engine_start(), and TEST_F().

◆ fl_dart_project_get_assets_path()

const gchar* fl_dart_project_get_assets_path ( FlDartProject *  project)

fl_dart_project_get_assets_path: @project: an #FlDartProject.

Gets the path to the directory containing the assets used in the Flutter application.

Returns: (type filename): an absolute directory path, e.g. "/projects/my_dart_project/data/flutter_assets".

Definition at line 90 of file fl_dart_project.cc.

91  {
92  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
93  return self->assets_path;
94 }

Referenced by fl_engine_start(), and TEST_F().

◆ fl_dart_project_get_dart_entrypoint_arguments()

gchar** fl_dart_project_get_dart_entrypoint_arguments ( FlDartProject *  project)

fl_dart_project_get_dart_entrypoint_arguments: @project: an #FlDartProject.

Gets the command line arguments to be passed through to the Dart entrypoint function.

Returns: a NULL-terminated array of strings containing the command line arguments to be passed to the Dart entrypoint.

Definition at line 109 of file fl_dart_project.cc.

110  {
111  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
112  return self->dart_entrypoint_args;
113 }

Referenced by fl_engine_start(), and TEST_F().

◆ fl_dart_project_get_enable_flutter_gpu()

gboolean fl_dart_project_get_enable_flutter_gpu ( FlDartProject *  project)

fl_dart_project_get_enable_flutter_gpu: @project: an #FlDartProject.

Returns: TRUE if the Flutter GPU API is enabled.

Definition at line 158 of file fl_dart_project.cc.

158  {
159  g_return_val_if_fail(FL_IS_DART_PROJECT(project), FALSE);
160  return project->enable_flutter_gpu;
161 }

Referenced by fl_engine_start(), and TEST_F().

◆ fl_dart_project_get_enable_impeller()

gboolean fl_dart_project_get_enable_impeller ( FlDartProject *  project)

fl_dart_project_get_enable_impeller: @project: an #FlDartProject.

Returns: TRUE if the Impeller renderer is enabled.

Definition at line 145 of file fl_dart_project.cc.

145  {
146  g_return_val_if_fail(FL_IS_DART_PROJECT(project), FALSE);
147  return project->enable_impeller;
148 }

Referenced by fl_engine_start(), and TEST_F().

◆ fl_dart_project_get_icu_data_path()

const gchar* fl_dart_project_get_icu_data_path ( FlDartProject *  project)

fl_dart_project_get_icu_data_path: @project: an #FlDartProject.

Gets the path to the ICU data file in the Flutter application.

Returns: (type filename): an absolute file path, e.g. "/projects/my_dart_project/data/icudtl.dat".

Definition at line 103 of file fl_dart_project.cc.

104  {
105  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
106  return self->icu_data_path;
107 }

Referenced by fl_engine_start(), and TEST_F().

◆ fl_dart_project_get_ui_thread_policy()

FlUIThreadPolicy fl_dart_project_get_ui_thread_policy ( FlDartProject *  project)

fl_dart_project_get_ui_thread_policy: @project: an #FlDartProject.

Returns: the thread policy used for running the UI isolate.

Definition at line 131 of file fl_dart_project.cc.

131  {
132  g_return_val_if_fail(FL_IS_DART_PROJECT(project),
133  FL_UI_THREAD_POLICY_DEFAULT);
134  return project->ui_thread_policy;
135 }

References FL_UI_THREAD_POLICY_DEFAULT.

Referenced by fl_engine_start().

◆ fl_dart_project_new()

G_BEGIN_DECLS G_MODULE_EXPORT FlDartProject* fl_dart_project_new ( )

FlDartProject:

#FlDartProject represents a Dart project. It is used to provide information about the application when creating an #FlView. fl_dart_project_new:

Creates a Flutter project for the currently running executable. The following data files are required relative to the location of the executable:

  • data/flutter_assets/ (as built by the Flutter tool).
  • data/icudtl.dat (provided as a resource by the Flutter tool).
  • lib/libapp.so (as built by the Flutter tool when in AOT mode).

Returns: a new #FlDartProject.

Definition at line 54 of file fl_dart_project.cc.

54  {
55  FlDartProject* self =
56  FL_DART_PROJECT(g_object_new(fl_dart_project_get_type(), nullptr));
57 
58  g_autofree gchar* executable_dir = get_executable_dir();
59  self->aot_library_path =
60  g_build_filename(executable_dir, "lib", "libapp.so", nullptr);
61  self->assets_path =
62  g_build_filename(executable_dir, "data", "flutter_assets", nullptr);
63  self->icu_data_path =
64  g_build_filename(executable_dir, "data", "icudtl.dat", nullptr);
65  self->enable_impeller = TRUE;
66 
67  return self;
68 }
TRUE
return TRUE
Definition: fl_compositor_software.cc:68
get_executable_dir
static gchar * get_executable_dir()
Definition: fl_dart_project.cc:25

References get_executable_dir(), and TRUE.

Referenced by fl_application_activate(), fl_engine_new_with_binary_messenger(), TEST(), and TEST_F().

◆ fl_dart_project_set_aot_library_path()

void fl_dart_project_set_aot_library_path ( FlDartProject *  project,
const gchar *  path 
)

fl_dart_project_set_aot_library_path: @project: an #FlDartProject. @path: the absolute path to the AOT library in the Flutter application.

Sets the path to the AOT library in the Flutter application, which is the path to libapp.so. By default this is lib/libapp.so relative to the executable directory.

Definition at line 70 of file fl_dart_project.cc.

71  {
72  g_return_if_fail(FL_IS_DART_PROJECT(self));
73  g_clear_pointer(&self->aot_library_path, g_free);
74  self->aot_library_path = g_strdup(path);
75 }

Referenced by TEST_F().

◆ fl_dart_project_set_assets_path()

void fl_dart_project_set_assets_path ( FlDartProject *  project,
gchar *  path 
)

fl_dart_project_set_assets_path: @project: an #FlDartProject. @path: the absolute path to the assets directory.

Sets the path to the directory containing the assets used in the Flutter application. By default, this is the data/flutter_assets subdirectory relative to the executable directory.

Definition at line 83 of file fl_dart_project.cc.

84  {
85  g_return_if_fail(FL_IS_DART_PROJECT(self));
86  g_clear_pointer(&self->assets_path, g_free);
87  self->assets_path = g_strdup(path);
88 }

Referenced by TEST_F().

◆ fl_dart_project_set_dart_entrypoint_arguments()

void fl_dart_project_set_dart_entrypoint_arguments ( FlDartProject *  project,
char **  argv 
)

fl_dart_project_set_dart_entrypoint_arguments: @project: an #FlDartProject. @argv: a pointer to a NULL-terminated array of C strings containing the command line arguments.

Sets the command line arguments to be passed through to the Dart entrypoint function.

Definition at line 115 of file fl_dart_project.cc.

117  {
118  g_return_if_fail(FL_IS_DART_PROJECT(self));
119  g_clear_pointer(&self->dart_entrypoint_args, g_strfreev);
120  self->dart_entrypoint_args = g_strdupv(argv);
121 }

Referenced by fl_application_activate(), and TEST_F().

◆ fl_dart_project_set_enable_flutter_gpu()

void fl_dart_project_set_enable_flutter_gpu ( FlDartProject *  project,
gboolean  enable_flutter_gpu 
)

fl_dart_project_set_enable_flutter_gpu: @project: an #FlDartProject. @enable_flutter_gpu: whether to enable the Flutter GPU API.

Sets whether the Flutter GPU API (package:flutter_gpu) should be enabled. Flutter GPU requires the Impeller renderer.

Definition at line 151 of file fl_dart_project.cc.

152  {
153  g_return_if_fail(FL_IS_DART_PROJECT(project));
154  project->enable_flutter_gpu = enable_flutter_gpu;
155 }

Referenced by TEST_F().

◆ fl_dart_project_set_enable_impeller()

void fl_dart_project_set_enable_impeller ( FlDartProject *  project,
gboolean  enable_impeller 
)

fl_dart_project_set_enable_impeller: @project: an #FlDartProject. @enable_impeller: whether to enable the Impeller renderer.

Sets whether the Impeller renderer should be enabled.

Definition at line 138 of file fl_dart_project.cc.

139  {
140  g_return_if_fail(FL_IS_DART_PROJECT(project));
141  project->enable_impeller = enable_impeller;
142 }

Referenced by TEST_F().

◆ fl_dart_project_set_icu_data_path()

void fl_dart_project_set_icu_data_path ( FlDartProject *  project,
gchar *  path 
)

fl_dart_project_set_icu_data_path: @project: an #FlDartProject. @path: the absolute path to the ICU data file.

Sets the path to the ICU data file used in the Flutter application. By default, this is data/icudtl.dat relative to the executable directory.

Definition at line 96 of file fl_dart_project.cc.

97  {
98  g_return_if_fail(FL_IS_DART_PROJECT(self));
99  g_clear_pointer(&self->icu_data_path, g_free);
100  self->icu_data_path = g_strdup(path);
101 }

Referenced by TEST_F().

◆ fl_dart_project_set_ui_thread_policy()

void fl_dart_project_set_ui_thread_policy ( FlDartProject *  project,
FlUIThreadPolicy  policy 
)

fl_dart_project_set_ui_thread_policy: @project: an #FlDartProject. @policy: the thread policy to use for running the UI isolate.

Definition at line 124 of file fl_dart_project.cc.

125  {
126  g_return_if_fail(FL_IS_DART_PROJECT(project));
127  project->ui_thread_policy = policy;
128 }

Referenced by TEST_F().