fl_plugin_registrar.cc File Reference

#include "flutter/shell/platform/linux/public/flutter_linux/fl_plugin_registrar.h"
#include "flutter/shell/platform/linux/fl_plugin_registrar_private.h"
#include <gmodule.h>

Go to the source code of this file.

Functions
	G_DECLARE_FINAL_TYPE (FlPluginRegistrarImpl, fl_plugin_registrar_impl, FL, PLUGIN_REGISTRAR_IMPL, GObject) struct _FlPluginRegistrarImpl
static void	fl_plugin_registrar_impl_iface_init (FlPluginRegistrarInterface *iface)
	G_DEFINE_TYPE_WITH_CODE (FlPluginRegistrarImpl, fl_plugin_registrar_impl, G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE(fl_plugin_registrar_get_type(), fl_plugin_registrar_impl_iface_init)) static void fl_plugin_registrar_default_init(FlPluginRegistrarInterface *iface)
static void	fl_plugin_registrar_impl_dispose (GObject *object)
static void	fl_plugin_registrar_impl_class_init (FlPluginRegistrarImplClass *klass)
static FlBinaryMessenger *	get_messenger (FlPluginRegistrar *registrar)
static FlTextureRegistrar *	get_texture_registrar (FlPluginRegistrar *registrar)
static FlView *	get_view (FlPluginRegistrar *registrar)
static void	fl_plugin_registrar_impl_init (FlPluginRegistrarImpl *self)
FlPluginRegistrar *	fl_plugin_registrar_new (FlView *view, FlBinaryMessenger *messenger, FlTextureRegistrar *texture_registrar)
G_MODULE_EXPORT FlBinaryMessenger *	fl_plugin_registrar_get_messenger (FlPluginRegistrar *self)
G_MODULE_EXPORT FlTextureRegistrar *	fl_plugin_registrar_get_texture_registrar (FlPluginRegistrar *self)
G_MODULE_EXPORT FlView *	fl_plugin_registrar_get_view (FlPluginRegistrar *self)

Function Documentation

fl_plugin_registrar_get_messenger()

G_MODULE_EXPORT FlBinaryMessenger* fl_plugin_registrar_get_messenger

(

FlPluginRegistrar *

registrar

)

FlPluginRegistrar:

#FlPluginRegistrar is used when registering new plugins. fl_plugin_registrar_get_messenger: @registrar: an #FlPluginRegistrar.

Gets the messenger this plugin can communicate with.

Returns: an #FlBinaryMessenger.

Definition at line 106 of file fl_plugin_registrar.cc.

                             {
  g_return_val_if_fail(FL_IS_PLUGIN_REGISTRAR(self), nullptr);
 
  return FL_PLUGIN_REGISTRAR_GET_IFACE(self)->get_messenger(self);
}

Referenced by TEST().

fl_plugin_registrar_get_texture_registrar()

G_MODULE_EXPORT FlTextureRegistrar* fl_plugin_registrar_get_texture_registrar

(

FlPluginRegistrar *

registrar

)

fl_plugin_registrar_get_texture_registrar: @registrar: an #FlPluginRegistrar.

Gets the texture registrar this plugin can communicate with.

Returns: an #FlTextureRegistrar.

Definition at line 113 of file fl_plugin_registrar.cc.

                             {
  g_return_val_if_fail(FL_IS_PLUGIN_REGISTRAR(self), nullptr);
 
  return FL_PLUGIN_REGISTRAR_GET_IFACE(self)->get_texture_registrar(self);
}

Referenced by TEST().

fl_plugin_registrar_get_view()

G_MODULE_EXPORT FlView* fl_plugin_registrar_get_view

(

FlPluginRegistrar *

registrar

)

fl_plugin_registrar_get_view: @registrar: an #FlPluginRegistrar.

Get the view that Flutter is rendering with.

Returns: (allow-none): an #FlView or NULL if running in headless mode.

Definition at line 120 of file fl_plugin_registrar.cc.

                                                                              {
  g_return_val_if_fail(FL_IS_PLUGIN_REGISTRAR(self), nullptr);
 
  return FL_PLUGIN_REGISTRAR_GET_IFACE(self)->get_view(self);
}

fl_plugin_registrar_impl_class_init()

static void fl_plugin_registrar_impl_class_init ( FlPluginRegistrarImplClass *  klass )

static

Definition at line 54 of file fl_plugin_registrar.cc.

                                       {
  G_OBJECT_CLASS(klass)->dispose = fl_plugin_registrar_impl_dispose;
}

References fl_plugin_registrar_impl_dispose().

fl_plugin_registrar_impl_dispose()

static void fl_plugin_registrar_impl_dispose ( GObject *  object )

static

Definition at line 44 of file fl_plugin_registrar.cc.

                                                              {
  FlPluginRegistrarImpl* self = FL_PLUGIN_REGISTRAR_IMPL(object);
 
  g_weak_ref_clear(&self->view);
  g_clear_object(&self->messenger);
  g_clear_object(&self->texture_registrar);
 
  G_OBJECT_CLASS(fl_plugin_registrar_impl_parent_class)->dispose(object);
}

Referenced by fl_plugin_registrar_impl_class_init().

fl_plugin_registrar_impl_iface_init()

static void fl_plugin_registrar_impl_iface_init ( FlPluginRegistrarInterface *  iface )

static

Definition at line 75 of file fl_plugin_registrar.cc.

                                       {
  iface->get_messenger = get_messenger;
  iface->get_texture_registrar = get_texture_registrar;
  iface->get_view = get_view;
}

References get_messenger(), get_texture_registrar(), and get_view().

fl_plugin_registrar_impl_init()

static void fl_plugin_registrar_impl_init ( FlPluginRegistrarImpl *  self )

static

Definition at line 82 of file fl_plugin_registrar.cc.

{}

fl_plugin_registrar_new()

FlPluginRegistrar* fl_plugin_registrar_new	(	FlView *	view,
		FlBinaryMessenger *	messenger,
		FlTextureRegistrar *	texture_registrar
	)

fl_plugin_registrar_new: @view: (allow-none): the #FlView that is being plugged into or NULL for headless mode. @messenger: the #FlBinaryMessenger to communicate with. @texture_registrar: the #FlTextureRegistrar to communicate with.

Creates a new #FlPluginRegistrar.

Returns: a new #FlPluginRegistrar.

Definition at line 84 of file fl_plugin_registrar.cc.

                                           {
  g_return_val_if_fail(view == nullptr || FL_IS_VIEW(view), nullptr);
  g_return_val_if_fail(FL_IS_BINARY_MESSENGER(messenger), nullptr);
  g_return_val_if_fail(FL_IS_TEXTURE_REGISTRAR(texture_registrar), nullptr);
 
  FlPluginRegistrarImpl* self = FL_PLUGIN_REGISTRAR_IMPL(
      g_object_new(fl_plugin_registrar_impl_get_type(), nullptr));
 
  // Added to stop compiler complaining about an unused function.
  FL_IS_PLUGIN_REGISTRAR_IMPL(self);
 
  g_weak_ref_init(&self->view, view);
  self->messenger = FL_BINARY_MESSENGER(g_object_ref(messenger));
  self->texture_registrar =
      FL_TEXTURE_REGISTRAR(g_object_ref(texture_registrar));
 
  return FL_PLUGIN_REGISTRAR(self);
}

References view.

Referenced by fl_engine_get_registrar_for_plugin(), and fl_view_get_registrar_for_plugin().

G_DECLARE_FINAL_TYPE()

G_DECLARE_FINAL_TYPE	(	FlPluginRegistrarImpl	,
		fl_plugin_registrar_impl	,
		FL	,
		PLUGIN_REGISTRAR_IMPL	,
		GObject
	)

Definition at line 10 of file fl_plugin_registrar.cc.

                              {
  GObject parent_instance;
 
  // View that plugin is controlling.
  GWeakRef view;
 
  // Messenger to communicate on.
  FlBinaryMessenger* messenger;
 
  // Texture registrar in use.
  FlTextureRegistrar* texture_registrar;
};

References view.

G_DEFINE_TYPE_WITH_CODE()

G_DEFINE_TYPE_WITH_CODE	(	FlPluginRegistrarImpl	,
		fl_plugin_registrar_impl	,
		G_TYPE_OBJECT	,
		G_IMPLEMENT_INTERFACE(fl_plugin_registrar_get_type(), fl_plugin_registrar_impl_iface_init)
	)

Definition at line 34 of file fl_plugin_registrar.cc.

                                       {}

get_messenger()

static FlBinaryMessenger* get_messenger ( FlPluginRegistrar *  registrar )

static

Definition at line 59 of file fl_plugin_registrar.cc.

                                                                      {
  FlPluginRegistrarImpl* self = FL_PLUGIN_REGISTRAR_IMPL(registrar);
  return self->messenger;
}

Referenced by fl_plugin_registrar_impl_iface_init().

get_texture_registrar()

static FlTextureRegistrar* get_texture_registrar ( FlPluginRegistrar *  registrar )

static

Definition at line 64 of file fl_plugin_registrar.cc.

                                                                               {
  FlPluginRegistrarImpl* self = FL_PLUGIN_REGISTRAR_IMPL(registrar);
  return self->texture_registrar;
}

Referenced by fl_plugin_registrar_impl_iface_init().

get_view()

static FlView* get_view ( FlPluginRegistrar *  registrar )

static

Definition at line 69 of file fl_plugin_registrar.cc.

                                                      {
  FlPluginRegistrarImpl* self = FL_PLUGIN_REGISTRAR_IMPL(registrar);
  g_autoptr(FlView) view = FL_VIEW(g_weak_ref_get(&self->view));
  return view;
}

References view.

Referenced by fl_plugin_registrar_impl_iface_init().