fl_dart_project.h File Reference

#include <glib-object.h>
#include <gmodule.h>

Go to the source code of this file.

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)

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 72 of file fl_dart_project.cc.

                         {
  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
  return self->aot_library_path;
}

Referenced by fl_engine_start(), and TEST().

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 85 of file fl_dart_project.cc.

                         {
  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
  return self->assets_path;
}

Referenced by fl_engine_start(), and TEST().

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 104 of file fl_dart_project.cc.

                         {
  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
  return self->dart_entrypoint_args;
}

Referenced by fl_engine_start(), and TEST().

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 98 of file fl_dart_project.cc.

                         {
  g_return_val_if_fail(FL_IS_DART_PROJECT(self), nullptr);
  return self->icu_data_path;
}

Referenced by fl_engine_start(), and TEST().

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 50 of file fl_dart_project.cc.

                                                     {
  FlDartProject* self =
      FL_DART_PROJECT(g_object_new(fl_dart_project_get_type(), nullptr));
 
  g_autofree gchar* executable_dir = get_executable_dir();
  self->aot_library_path =
      g_build_filename(executable_dir, "lib", "libapp.so", nullptr);
  self->assets_path =
      g_build_filename(executable_dir, "data", "flutter_assets", nullptr);
  self->icu_data_path =
      g_build_filename(executable_dir, "data", "icudtl.dat", nullptr);
 
  return self;
}

References get_executable_dir().

Referenced by make_mock_engine(), and TEST().

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 65 of file fl_dart_project.cc.

                                                                             {
  g_return_if_fail(FL_IS_DART_PROJECT(self));
  g_clear_pointer(&self->aot_library_path, g_free);
  self->aot_library_path = g_strdup(path);
}

Referenced by TEST().

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 78 of file fl_dart_project.cc.

                                                                  {
  g_return_if_fail(FL_IS_DART_PROJECT(self));
  g_clear_pointer(&self->assets_path, g_free);
  self->assets_path = g_strdup(path);
}

Referenced by TEST().

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 110 of file fl_dart_project.cc.

                 {
  g_return_if_fail(FL_IS_DART_PROJECT(self));
  g_clear_pointer(&self->dart_entrypoint_args, g_strfreev);
  self->dart_entrypoint_args = g_strdupv(argv);
}

Referenced by TEST().

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 91 of file fl_dart_project.cc.

                                                                    {
  g_return_if_fail(FL_IS_DART_PROJECT(self));
  g_clear_pointer(&self->icu_data_path, g_free);
  self->icu_data_path = g_strdup(path);
}

Referenced by TEST().