fl_platform_handler.cc File Reference

#include "flutter/shell/platform/linux/fl_platform_handler.h"
#include <gtk/gtk.h>
#include <cstring>
#include "flutter/shell/platform/linux/fl_platform_channel.h"
#include "flutter/shell/platform/linux/public/flutter_linux/fl_method_channel.h"

Go to the source code of this file.

Classes
struct	_FlPlatformHandler

Functions
static void	clipboard_text_cb (GtkClipboard *clipboard, const gchar *text, gpointer user_data)
static void	clipboard_text_has_strings_cb (GtkClipboard *clipboard, const gchar *text, gpointer user_data)
static FlMethodResponse *	clipboard_set_data (FlMethodCall *method_call, const gchar *text, gpointer user_data)
static FlMethodResponse *	clipboard_get_data (FlMethodCall *method_call, const gchar *format, gpointer user_data)
static FlMethodResponse *	clipboard_has_strings (FlMethodCall *method_call, gpointer user_data)
static void	quit_application ()
static void	request_app_exit_response_cb (GObject *object, GAsyncResult *result, gpointer user_data)
static void	request_app_exit (FlPlatformHandler *self, FlPlatformChannelExitType type)
static void	system_initialization_complete (gpointer user_data)
static FlMethodResponse *	system_exit_application (FlMethodCall *method_call, FlPlatformChannelExitType type, gpointer user_data)
static void	system_sound_play (const gchar *type, gpointer user_data)
static void	system_navigator_pop (gpointer user_data)
static void	fl_platform_handler_dispose (GObject *object)
static void	fl_platform_handler_class_init (FlPlatformHandlerClass *klass)
static void	fl_platform_handler_init (FlPlatformHandler *self)
FlPlatformHandler *	fl_platform_handler_new (FlBinaryMessenger *messenger)
void	fl_platform_handler_request_app_exit (FlPlatformHandler *self)

Variables
static constexpr char	kInProgressError [] = "In Progress"
static constexpr char	kUnknownClipboardFormatError []
static constexpr char	kTextPlainFormat [] = "text/plain"
static constexpr char	kSoundTypeAlert [] = "SystemSoundType.alert"
static constexpr char	kSoundTypeClick [] = "SystemSoundType.click"
static FlPlatformChannelVTable	platform_channel_vtable

Function Documentation

clipboard_get_data()

static FlMethodResponse* clipboard_get_data ( FlMethodCall *  method_call, const gchar *  format, gpointer  user_data  )

static

Definition at line 65 of file fl_platform_handler.cc.

                                                                {
  if (strcmp(format, kTextPlainFormat) != 0) {
    return FL_METHOD_RESPONSE(fl_method_error_response_new(
        kUnknownClipboardFormatError, "GTK clipboard API only supports text",
        nullptr));
  }
 
  GtkClipboard* clipboard =
      gtk_clipboard_get_default(gdk_display_get_default());
  gtk_clipboard_request_text(clipboard, clipboard_text_cb,
                             g_object_ref(method_call));
 
  // Will respond later.
  return nullptr;
}

References clipboard_text_cb(), fl_method_error_response_new(), format, kTextPlainFormat, kUnknownClipboardFormatError, and method_call.

clipboard_has_strings()

static FlMethodResponse* clipboard_has_strings ( FlMethodCall *  method_call, gpointer  user_data  )

static

Definition at line 85 of file fl_platform_handler.cc.

                                                                   {
  GtkClipboard* clipboard =
      gtk_clipboard_get_default(gdk_display_get_default());
  gtk_clipboard_request_text(clipboard, clipboard_text_has_strings_cb,
                             g_object_ref(method_call));
 
  // Will respond later.
  return nullptr;
}

References clipboard_text_has_strings_cb(), and method_call.

clipboard_set_data()

static FlMethodResponse* clipboard_set_data ( FlMethodCall *  method_call, const gchar *  text, gpointer  user_data  )

static

Definition at line 54 of file fl_platform_handler.cc.

                                                                {
  GtkClipboard* clipboard =
      gtk_clipboard_get_default(gdk_display_get_default());
  gtk_clipboard_set_text(clipboard, text, -1);
 
  return FL_METHOD_RESPONSE(fl_method_success_response_new(nullptr));
}

References fl_method_success_response_new().

clipboard_text_cb()

static void clipboard_text_cb ( GtkClipboard *  clipboard, const gchar *  text, gpointer  user_data  )

static

Definition at line 37 of file fl_platform_handler.cc.

                                                  {
  g_autoptr(FlMethodCall) method_call = FL_METHOD_CALL(user_data);
  fl_platform_channel_respond_clipboard_get_data(method_call, text);
}

References fl_platform_channel_respond_clipboard_get_data(), method_call, and user_data.

Referenced by clipboard_get_data().

clipboard_text_has_strings_cb()

static void clipboard_text_has_strings_cb ( GtkClipboard *  clipboard, const gchar *  text, gpointer  user_data  )

static

Definition at line 45 of file fl_platform_handler.cc.

                                                              {
  g_autoptr(FlMethodCall) method_call = FL_METHOD_CALL(user_data);
  fl_platform_channel_respond_clipboard_has_strings(
      method_call, text != nullptr && strlen(text) > 0);
}

References fl_platform_channel_respond_clipboard_has_strings(), method_call, and user_data.

Referenced by clipboard_has_strings().

fl_platform_handler_class_init()

static void fl_platform_handler_class_init ( FlPlatformHandlerClass *  klass )

static

Definition at line 233 of file fl_platform_handler.cc.

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

References fl_platform_handler_dispose().

fl_platform_handler_dispose()

static void fl_platform_handler_dispose ( GObject *  object )

static

Definition at line 221 of file fl_platform_handler.cc.

                                                         {
  FlPlatformHandler* self = FL_PLATFORM_HANDLER(object);
 
  g_cancellable_cancel(self->cancellable);
 
  g_clear_object(&self->channel);
  g_clear_object(&self->exit_application_method_call);
  g_clear_object(&self->cancellable);
 
  G_OBJECT_CLASS(fl_platform_handler_parent_class)->dispose(object);
}

Referenced by fl_platform_handler_class_init().

fl_platform_handler_init()

static void fl_platform_handler_init ( FlPlatformHandler *  self )

static

Definition at line 237 of file fl_platform_handler.cc.

                                                              {
  self->cancellable = g_cancellable_new();
}

fl_platform_handler_new()

FlPlatformHandler* fl_platform_handler_new

(

FlBinaryMessenger *

messenger

)

FlPlatformHandler:

#FlPlatformHandler is a handler that implements the shell side of SystemChannels.platform from the Flutter services library. fl_platform_handler_new: @messenger: an #FlBinaryMessenger

Creates a new handler that implements SystemChannels.platform from the Flutter services library.

Returns: a new #FlPlatformHandler

Definition at line 251 of file fl_platform_handler.cc.

                                                                         {
  g_return_val_if_fail(FL_IS_BINARY_MESSENGER(messenger), nullptr);
 
  FlPlatformHandler* self = FL_PLATFORM_HANDLER(
      g_object_new(fl_platform_handler_get_type(), nullptr));
 
  self->channel =
      fl_platform_channel_new(messenger, &platform_channel_vtable, self);
  self->app_initialization_complete = FALSE;
 
  return self;
}

References fl_platform_channel_new(), and platform_channel_vtable.

Referenced by fl_engine_start(), fl_test_application_activate(), and TEST().

fl_platform_handler_request_app_exit()

void fl_platform_handler_request_app_exit

(

FlPlatformHandler *

handler

)

fl_platform_handler_request_app_exit: @handler: an #FlPlatformHandler

Request the application exits (i.e. due to the window being requested to be closed).

Calling this will only send an exit request to the framework if the framework has already indicated that it is ready to receive requests by sending a "System.initializationComplete" method call on the platform channel. Calls before initialization is complete will result in an immediate exit.

Definition at line 264 of file fl_platform_handler.cc.

                                                                   {
  g_return_if_fail(FL_IS_PLATFORM_HANDLER(self));
  // Request a cancellable exit.
  request_app_exit(self, FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE);
}

References FL_PLATFORM_CHANNEL_EXIT_TYPE_CANCELABLE, and request_app_exit().

Referenced by fl_engine_request_app_exit().

quit_application()

static void quit_application ( )

static

Definition at line 97 of file fl_platform_handler.cc.

                               {
  GApplication* app = g_application_get_default();
  if (app == nullptr) {
    // Unable to gracefully quit, so just exit the process.
    exit(0);
  }
 
  // GtkApplication windows contain a reference back to the application.
  // Break them so the application object can cleanup.
  // See https://gitlab.gnome.org/GNOME/gtk/-/issues/6190
  if (GTK_IS_APPLICATION(app)) {
    // List is copied as it will be modified as windows are disconnected from
    // the application.
    g_autoptr(GList) windows =
        g_list_copy(gtk_application_get_windows(GTK_APPLICATION(app)));
    for (GList* link = windows; link != NULL; link = link->next) {
      GtkWidget* window = GTK_WIDGET(link->data);
      gtk_window_set_application(GTK_WINDOW(window), NULL);
    }
  }
 
  g_application_quit(app);
}

Referenced by request_app_exit(), request_app_exit_response_cb(), system_exit_application(), and system_navigator_pop().

request_app_exit()

static void request_app_exit ( FlPlatformHandler *  self, FlPlatformChannelExitType  type  )

static

Definition at line 152 of file fl_platform_handler.cc.

                                                             {
  if (!self->app_initialization_complete ||
      type == FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED) {
    quit_application();
    return;
  }
 
  fl_platform_channel_system_request_app_exit(
      self->channel, type, self->cancellable, request_app_exit_response_cb,
      self);
}

References FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED, fl_platform_channel_system_request_app_exit(), quit_application(), request_app_exit_response_cb(), and type.

Referenced by fl_platform_handler_request_app_exit(), and system_exit_application().

request_app_exit_response_cb()

static void request_app_exit_response_cb ( GObject *  object, GAsyncResult *  result, gpointer  user_data  )

static

Definition at line 122 of file fl_platform_handler.cc.

                                                             {
  FlPlatformHandler* self = FL_PLATFORM_HANDLER(user_data);
 
  g_autoptr(GError) error = nullptr;
  FlPlatformChannelExitResponse exit_response;
  if (!fl_platform_channel_system_request_app_exit_finish(
          object, result, &exit_response, &error)) {
    if (g_error_matches(error, G_IO_ERROR, G_IO_ERROR_CANCELLED)) {
      return;
    }
    g_warning("Failed to complete System.requestAppExit: %s", error->message);
    quit_application();
    return;
  }
 
  if (exit_response == FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT) {
    quit_application();
  }
 
  // If request was due to a request from Flutter, pass result back.
  if (self->exit_application_method_call != nullptr) {
    fl_platform_channel_respond_system_exit_application(
        self->exit_application_method_call, exit_response);
  }
}

References error, FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT, fl_platform_channel_respond_system_exit_application(), fl_platform_channel_system_request_app_exit_finish(), quit_application(), and user_data.

Referenced by request_app_exit().

system_exit_application()

static FlMethodResponse* system_exit_application ( FlMethodCall *  method_call, FlPlatformChannelExitType  type, gpointer  user_data  )

static

Definition at line 174 of file fl_platform_handler.cc.

                                                                     {
  FlPlatformHandler* self = FL_PLATFORM_HANDLER(user_data);
  // Save method call to respond to when our request to Flutter completes.
  if (self->exit_application_method_call != nullptr) {
    return FL_METHOD_RESPONSE(fl_method_error_response_new(
        kInProgressError, "Request already in progress", nullptr));
  }
  self->exit_application_method_call =
      FL_METHOD_CALL(g_object_ref(method_call));
 
  // Requested to immediately quit if the app hasn't yet signaled that it is
  // ready to handle requests, or if the type of exit requested is "required".
  if (!self->app_initialization_complete ||
      type == FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED) {
    quit_application();
    return fl_platform_channel_make_system_request_app_exit_response(
        FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT);
  }
 
  // Send the request back to Flutter to follow the standard process.
  request_app_exit(self, type);
 
  // Will respond later.
  return nullptr;
}

References fl_method_error_response_new(), FL_PLATFORM_CHANNEL_EXIT_RESPONSE_EXIT, FL_PLATFORM_CHANNEL_EXIT_TYPE_REQUIRED, fl_platform_channel_make_system_request_app_exit_response(), kInProgressError, method_call, quit_application(), request_app_exit(), type, and user_data.

system_initialization_complete()

static void system_initialization_complete ( gpointer  user_data )

static

Definition at line 168 of file fl_platform_handler.cc.

                                                               {
  FlPlatformHandler* self = FL_PLATFORM_HANDLER(user_data);
  self->app_initialization_complete = TRUE;
}

References TRUE, and user_data.

system_navigator_pop()

static void system_navigator_pop ( gpointer  user_data )

static

Definition at line 217 of file fl_platform_handler.cc.

                                                     {
  quit_application();
}

References quit_application().

system_sound_play()

static void system_sound_play ( const gchar *  type, gpointer  user_data  )

static

Definition at line 203 of file fl_platform_handler.cc.

                                                                     {
  if (strcmp(type, kSoundTypeAlert) == 0) {
    GdkDisplay* display = gdk_display_get_default();
    if (display != nullptr) {
      gdk_display_beep(display);
    }
  } else if (strcmp(type, kSoundTypeClick) == 0) {
    // We don't make sounds for keyboard on desktops.
  } else {
    g_warning("Ignoring unknown sound type %s in SystemSound.play.\n", type);
  }
}

References kSoundTypeAlert, kSoundTypeClick, and type.

Variable Documentation

kInProgressError

constexpr char kInProgressError[] = "In Progress"

staticconstexpr

Definition at line 13 of file fl_platform_handler.cc.

Referenced by system_exit_application().

kSoundTypeAlert

constexpr char kSoundTypeAlert[] = "SystemSoundType.alert"

staticconstexpr

Definition at line 19 of file fl_platform_handler.cc.

Referenced by system_sound_play().

kSoundTypeClick

constexpr char kSoundTypeClick[] = "SystemSoundType.click"

staticconstexpr

Definition at line 20 of file fl_platform_handler.cc.

Referenced by system_sound_play().

kTextPlainFormat

constexpr char kTextPlainFormat[] = "text/plain"

staticconstexpr

Definition at line 17 of file fl_platform_handler.cc.

Referenced by clipboard_get_data().

kUnknownClipboardFormatError

constexpr char kUnknownClipboardFormatError[]

staticconstexpr

Initial value:

=
    "Unknown Clipboard Format"

Definition at line 14 of file fl_platform_handler.cc.

Referenced by clipboard_get_data().

platform_channel_vtable

FlPlatformChannelVTable platform_channel_vtable

static

Initial value:

= {
    .clipboard_set_data = clipboard_set_data,
    .clipboard_get_data = clipboard_get_data,
    .clipboard_has_strings = clipboard_has_strings,
    .system_exit_application = system_exit_application,
    .system_initialization_complete = system_initialization_complete,
    .system_sound_play = system_sound_play,
    .system_navigator_pop = system_navigator_pop,
}

Definition at line 241 of file fl_platform_handler.cc.

Referenced by fl_platform_handler_new().