fl_settings_portal.cc File Reference

#include "flutter/shell/platform/linux/fl_settings_portal.h"
#include <gio/gio.h>
#include <glib.h>

Go to the source code of this file.

Classes
struct	FlSetting
struct	_FlSettingsPortal

Enumerations
enum	ColorScheme {   COLOR_SCHEME_DEFAULT ,   COLOR_SCHEME_PREFER_DARK ,   COLOR_SCHEME_PREFER_LIGHT }

Functions
static void	fl_settings_portal_iface_init (FlSettingsInterface *iface)
	G_DEFINE_TYPE_WITH_CODE (FlSettingsPortal, fl_settings_portal, G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE(fl_settings_get_type(), fl_settings_portal_iface_init)) static gchar *format_key(const FlSetting *setting)
static gboolean	get_value (FlSettingsPortal *portal, const FlSetting *setting, GVariant **value)
static void	set_value (FlSettingsPortal *portal, const FlSetting *setting, GVariant *value)
static gboolean	settings_portal_read (GDBusProxy *proxy, const gchar *ns, const gchar *key, GVariant **out)
static void	settings_portal_changed_cb (GDBusProxy *proxy, const char *sender_name, const char *signal_name, GVariant *parameters, gpointer user_data)
static FlClockFormat	fl_settings_portal_get_clock_format (FlSettings *settings)
static FlColorScheme	fl_settings_portal_get_color_scheme (FlSettings *settings)
static gboolean	fl_settings_portal_get_enable_animations (FlSettings *settings)
static gboolean	fl_settings_portal_get_high_contrast (FlSettings *settings)
static gdouble	fl_settings_portal_get_text_scaling_factor (FlSettings *settings)
static void	fl_settings_portal_dispose (GObject *object)
static void	fl_settings_portal_class_init (FlSettingsPortalClass *klass)
static void	fl_settings_portal_init (FlSettingsPortal *self)
FlSettingsPortal *	fl_settings_portal_new ()
FlSettingsPortal *	fl_settings_portal_new_with_values (GVariantDict *values)
gboolean	fl_settings_portal_start (FlSettingsPortal *self, GError **error)

Variables
static constexpr char	kPortalName [] = "org.freedesktop.portal.Desktop"
static constexpr char	kPortalPath [] = "/org/freedesktop/portal/desktop"
static constexpr char	kPortalSettings [] = "org.freedesktop.portal.Settings"
static constexpr char	kXdgAppearance [] = "org.freedesktop.appearance"
static const FlSetting	kColorScheme
static constexpr char	kGnomeA11yInterface []
static const FlSetting	kHighContrast
static constexpr char	kGnomeDesktopInterface [] = "org.gnome.desktop.interface"
static const FlSetting	kClockFormat
static const FlSetting	kEnableAnimations
static const FlSetting	kGtkTheme
static const FlSetting	kTextScalingFactor
static const FlSetting	kAllSettings []
static constexpr char	kClockFormat12Hour [] = "12h"
static constexpr char	kGtkThemeDarkSuffix [] = "-dark"

Enumeration Type Documentation

ColorScheme

enum ColorScheme

Enumerator
COLOR_SCHEME_DEFAULT
COLOR_SCHEME_PREFER_DARK
COLOR_SCHEME_PREFER_LIGHT

Definition at line 65 of file fl_settings_portal.cc.

             {
  COLOR_SCHEME_DEFAULT,
  COLOR_SCHEME_PREFER_DARK,
  COLOR_SCHEME_PREFER_LIGHT
} ColorScheme;

Function Documentation

fl_settings_portal_class_init()

static void fl_settings_portal_class_init ( FlSettingsPortalClass *  klass )

static

Definition at line 252 of file fl_settings_portal.cc.

                                                                        {
  GObjectClass* object_class = G_OBJECT_CLASS(klass);
  object_class->dispose = fl_settings_portal_dispose;
}

References fl_settings_portal_dispose().

fl_settings_portal_dispose()

static void fl_settings_portal_dispose ( GObject *  object )

static

Definition at line 243 of file fl_settings_portal.cc.

                                                        {
  FlSettingsPortal* self = FL_SETTINGS_PORTAL(object);
 
  g_clear_object(&self->dbus_proxy);
  g_clear_pointer(&self->values, g_variant_dict_unref);
 
  G_OBJECT_CLASS(fl_settings_portal_parent_class)->dispose(object);
}

References self.

Referenced by fl_settings_portal_class_init().

fl_settings_portal_get_clock_format()

static FlClockFormat fl_settings_portal_get_clock_format ( FlSettings *  settings )

static

Definition at line 167 of file fl_settings_portal.cc.

                                                                               {
  FlSettingsPortal* self = FL_SETTINGS_PORTAL(settings);
 
  FlClockFormat clock_format = FL_CLOCK_FORMAT_24H;
 
  g_autoptr(GVariant) value = nullptr;
  if (get_value(self, &kClockFormat, &value)) {
    const gchar* clock_format_str = g_variant_get_string(value, nullptr);
    if (g_strcmp0(clock_format_str, kClockFormat12Hour) == 0) {
      clock_format = FL_CLOCK_FORMAT_12H;
    }
  }
 
  return clock_format;
}

References FL_CLOCK_FORMAT_12H, FL_CLOCK_FORMAT_24H, g_autoptr(), get_value(), kClockFormat, kClockFormat12Hour, self, and value.

Referenced by fl_settings_portal_iface_init().

fl_settings_portal_get_color_scheme()

static FlColorScheme fl_settings_portal_get_color_scheme ( FlSettings *  settings )

static

Definition at line 183 of file fl_settings_portal.cc.

                                                                               {
  FlSettingsPortal* self = FL_SETTINGS_PORTAL(settings);
 
  FlColorScheme color_scheme = FL_COLOR_SCHEME_LIGHT;
 
  g_autoptr(GVariant) value = nullptr;
  if (get_value(self, &kColorScheme, &value)) {
    if (g_variant_get_uint32(value) == COLOR_SCHEME_PREFER_DARK) {
      color_scheme = FL_COLOR_SCHEME_DARK;
    }
  } else if (get_value(self, &kGtkTheme, &value)) {
    const gchar* gtk_theme_str = g_variant_get_string(value, nullptr);
    if (g_str_has_suffix(gtk_theme_str, kGtkThemeDarkSuffix)) {
      color_scheme = FL_COLOR_SCHEME_DARK;
    }
  }
 
  return color_scheme;
}

References COLOR_SCHEME_PREFER_DARK, FL_COLOR_SCHEME_DARK, FL_COLOR_SCHEME_LIGHT, g_autoptr(), get_value(), kColorScheme, kGtkTheme, kGtkThemeDarkSuffix, self, and value.

Referenced by fl_settings_portal_iface_init().

fl_settings_portal_get_enable_animations()

static gboolean fl_settings_portal_get_enable_animations ( FlSettings *  settings )

static

Definition at line 203 of file fl_settings_portal.cc.

                                                                               {
  FlSettingsPortal* self = FL_SETTINGS_PORTAL(settings);
 
  gboolean enable_animations = true;
 
  g_autoptr(GVariant) value = nullptr;
  if (get_value(self, &kEnableAnimations, &value)) {
    enable_animations = g_variant_get_boolean(value);
  }
 
  return enable_animations;
}

References g_autoptr(), get_value(), kEnableAnimations, self, and value.

Referenced by fl_settings_portal_iface_init().

fl_settings_portal_get_high_contrast()

static gboolean fl_settings_portal_get_high_contrast ( FlSettings *  settings )

static

Definition at line 216 of file fl_settings_portal.cc.

                                                                           {
  FlSettingsPortal* self = FL_SETTINGS_PORTAL(settings);
 
  gboolean high_contrast = false;
 
  g_autoptr(GVariant) value = nullptr;
  if (get_value(self, &kHighContrast, &value)) {
    high_contrast = g_variant_get_boolean(value);
  }
 
  return high_contrast;
}

References g_autoptr(), get_value(), kHighContrast, self, and value.

Referenced by fl_settings_portal_iface_init().

fl_settings_portal_get_text_scaling_factor()

static gdouble fl_settings_portal_get_text_scaling_factor ( FlSettings *  settings )

static

Definition at line 229 of file fl_settings_portal.cc.

                          {
  FlSettingsPortal* self = FL_SETTINGS_PORTAL(settings);
 
  gdouble scaling_factor = 1.0;
 
  g_autoptr(GVariant) value = nullptr;
  if (get_value(self, &kTextScalingFactor, &value)) {
    scaling_factor = g_variant_get_double(value);
  }
 
  return scaling_factor;
}

References g_autoptr(), get_value(), kTextScalingFactor, self, and value.

Referenced by fl_settings_portal_iface_init().

fl_settings_portal_iface_init()

static void fl_settings_portal_iface_init ( FlSettingsInterface *  iface )

static

Definition at line 257 of file fl_settings_portal.cc.

                                                                      {
  iface->get_clock_format = fl_settings_portal_get_clock_format;
  iface->get_color_scheme = fl_settings_portal_get_color_scheme;
  iface->get_enable_animations = fl_settings_portal_get_enable_animations;
  iface->get_high_contrast = fl_settings_portal_get_high_contrast;
  iface->get_text_scaling_factor = fl_settings_portal_get_text_scaling_factor;
}

References fl_settings_portal_get_clock_format(), fl_settings_portal_get_color_scheme(), fl_settings_portal_get_enable_animations(), fl_settings_portal_get_high_contrast(), and fl_settings_portal_get_text_scaling_factor().

fl_settings_portal_init()

static void fl_settings_portal_init ( FlSettingsPortal *  self )

static

Definition at line 265 of file fl_settings_portal.cc.

{}

fl_settings_portal_new()

FlSettingsPortal * fl_settings_portal_new

(

)

FlSettingsPortal: #FlSettingsPortal reads settings from the XDG desktop portal. fl_settings_portal_new:

Creates a new settings portal instance.

Returns: a new #FlSettingsPortal.

Definition at line 267 of file fl_settings_portal.cc.

                                           {
  g_autoptr(GVariantDict) values = g_variant_dict_new(nullptr);
  return fl_settings_portal_new_with_values(values);
}

References fl_settings_portal_new_with_values(), and g_autoptr().

Referenced by fl_settings_new().

fl_settings_portal_new_with_values()

FlSettingsPortal * fl_settings_portal_new_with_values

(

GVariantDict *

values

)

fl_settings_portal_new_with_values: @values: (nullable): a #GVariantDict.

Creates a new settings portal instance with initial values for testing.

Returns: a new #FlSettingsPortal.

Definition at line 272 of file fl_settings_portal.cc.

                                                                           {
  g_return_val_if_fail(values != nullptr, nullptr);
  FlSettingsPortal* portal =
      FL_SETTINGS_PORTAL(g_object_new(fl_settings_portal_get_type(), nullptr));
  portal->values = g_variant_dict_ref(values);
  return portal;
}

Referenced by fl_settings_portal_new(), TEST(), TEST(), TEST(), TEST(), TEST(), and TEST().

fl_settings_portal_start()

gboolean fl_settings_portal_start	(	FlSettingsPortal *	portal,
		GError **	error
	)

fl_settings_portal_start: @portal: an #FlSettingsPortal. @error: (allow-none): #GError location to store the error occurring, or NULL

Reads the current settings and starts monitoring for changes in the desktop portal settings.

Returns: TRUE on success, or FALSE if the portal is not available.

Definition at line 280 of file fl_settings_portal.cc.

                                                                          {
  g_return_val_if_fail(FL_IS_SETTINGS_PORTAL(self), false);
  g_return_val_if_fail(self->dbus_proxy == nullptr, false);
 
  self->dbus_proxy = g_dbus_proxy_new_for_bus_sync(
      G_BUS_TYPE_SESSION, G_DBUS_PROXY_FLAGS_NONE, nullptr, kPortalName,
      kPortalPath, kPortalSettings, nullptr, error);
 
  if (self->dbus_proxy == nullptr) {
    return FALSE;
  }
 
  for (const FlSetting setting : kAllSettings) {
    g_autoptr(GVariant) value = nullptr;
    if (settings_portal_read(self->dbus_proxy, setting.ns, setting.key,
                             &value)) {
      set_value(self, &setting, value);
    }
  }
 
  g_signal_connect_object(self->dbus_proxy, "g-signal",
                          G_CALLBACK(settings_portal_changed_cb), self,
                          static_cast<GConnectFlags>(0));
 
  return true;
}

References error, g_autoptr(), kAllSettings, kPortalName, kPortalPath, kPortalSettings, self, set_value(), settings_portal_changed_cb(), settings_portal_read(), and value.

Referenced by fl_settings_new().

G_DEFINE_TYPE_WITH_CODE()

G_DEFINE_TYPE_WITH_CODE	(	FlSettingsPortal	,
		fl_settings_portal	,
		G_TYPE_OBJECT	,
		G_IMPLEMENT_INTERFACE(fl_settings_get_type(), fl_settings_portal_iface_init)
	)		const

Definition at line 80 of file fl_settings_portal.cc.

                                                   {
  return g_strconcat(setting->ns, "::", setting->key, nullptr);
}

References FlSetting::key, and FlSetting::ns.

get_value()

static gboolean get_value ( FlSettingsPortal *  portal, const FlSetting *  setting, GVariant **  value  )

static

Definition at line 90 of file fl_settings_portal.cc.

                                            {
  g_autofree const gchar* key = format_key(setting);
  *value = g_variant_dict_lookup_value(portal->values, key, setting->type);
  return *value != nullptr;
}

References key, FlSetting::type, and value.

Referenced by fl_settings_portal_get_clock_format(), fl_settings_portal_get_color_scheme(), fl_settings_portal_get_enable_animations(), fl_settings_portal_get_high_contrast(), and fl_settings_portal_get_text_scaling_factor().

set_value()

static void set_value ( FlSettingsPortal *  portal, const FlSetting *  setting, GVariant *  value  )

static

Definition at line 98 of file fl_settings_portal.cc.

                                       {
  g_autofree const gchar* key = format_key(setting);
 
  // ignore redundant changes from multiple XDG desktop portal backends
  g_autoptr(GVariant) old_value =
      g_variant_dict_lookup_value(portal->values, key, nullptr);
  if (old_value != nullptr && value != nullptr &&
      g_variant_equal(old_value, value)) {
    return;
  }
 
  g_variant_dict_insert_value(portal->values, key, value);
  fl_settings_emit_changed(FL_SETTINGS(portal));
}

References fl_settings_emit_changed(), g_autoptr(), key, and value.

Referenced by fl_settings_portal_start(), and settings_portal_changed_cb().

settings_portal_changed_cb()

static void settings_portal_changed_cb ( GDBusProxy *  proxy, const char *  sender_name, const char *  signal_name, GVariant *  parameters, gpointer  user_data  )

static

Definition at line 151 of file fl_settings_portal.cc.

                                                           {
  FlSettingsPortal* portal = FL_SETTINGS_PORTAL(user_data);
  if (g_strcmp0(signal_name, "SettingChanged")) {
    return;
  }
 
  FlSetting setting;
  g_autoptr(GVariant) value = nullptr;
  g_variant_get(parameters, "(&s&sv)", &setting.ns, &setting.key, &value);
  set_value(portal, &setting, value);
}

References g_autoptr(), FlSetting::key, FlSetting::ns, set_value(), user_data, and value.

Referenced by fl_settings_portal_start().

settings_portal_read()

static gboolean settings_portal_read ( GDBusProxy *  proxy, const gchar *  ns, const gchar *  key, GVariant **  out  )

static

Definition at line 117 of file fl_settings_portal.cc.

                                                     {
  g_autoptr(GError) error = nullptr;
  g_autoptr(GVariant) value =
      g_dbus_proxy_call_sync(proxy, "Read", g_variant_new("(ss)", ns, key),
                             G_DBUS_CALL_FLAGS_NONE, G_MAXINT, nullptr, &error);
 
  if (error) {
    if (error->domain == G_DBUS_ERROR &&
        error->code == G_DBUS_ERROR_SERVICE_UNKNOWN) {
      g_debug("XDG desktop portal unavailable: %s", error->message);
      return FALSE;
    }
 
    if (error->domain == G_DBUS_ERROR &&
        error->code == G_DBUS_ERROR_UNKNOWN_METHOD) {
      g_debug("XDG desktop portal settings unavailable: %s", error->message);
      return FALSE;
    }
 
    g_critical("Failed to read XDG desktop portal settings: %s",
               error->message);
    return FALSE;
  }
 
  g_autoptr(GVariant) child = nullptr;
  g_variant_get(value, "(v)", &child);
  g_variant_get(child, "v", out);
 
  return TRUE;
}

References error, g_autoptr(), g_debug, key, TRUE, and value.

Referenced by fl_settings_portal_start().

Variable Documentation

kAllSettings

const FlSetting kAllSettings[]

static

Initial value:

= {
    kClockFormat, kColorScheme,  kEnableAnimations,
    kGtkTheme,    kHighContrast, kTextScalingFactor,
}

Definition at line 57 of file fl_settings_portal.cc.

                                        {
    kClockFormat, kColorScheme,  kEnableAnimations,
    kGtkTheme,    kHighContrast, kTextScalingFactor,
};

Referenced by fl_settings_portal_start().

kClockFormat

const FlSetting kClockFormat

static

Initial value:

= {
    kGnomeDesktopInterface,
    "clock-format",
    G_VARIANT_TYPE_STRING,
}

Definition at line 36 of file fl_settings_portal.cc.

                                      {
    kGnomeDesktopInterface,
    "clock-format",
    G_VARIANT_TYPE_STRING,
};

Referenced by fl_settings_portal_get_clock_format().

kClockFormat12Hour

constexpr char kClockFormat12Hour[] = "12h"

staticconstexpr

Definition at line 62 of file fl_settings_portal.cc.

Referenced by fl_settings_portal_get_clock_format().

kColorScheme

const FlSetting kColorScheme

static

Initial value:

= {
    kXdgAppearance,
    "color-scheme",
    G_VARIANT_TYPE_UINT32,
}

Definition at line 21 of file fl_settings_portal.cc.

                                      {
    kXdgAppearance,
    "color-scheme",
    G_VARIANT_TYPE_UINT32,
};

Referenced by fl_settings_portal_get_color_scheme().

kEnableAnimations

const FlSetting kEnableAnimations

static

Initial value:

= {
    kGnomeDesktopInterface,
    "enable-animations",
    G_VARIANT_TYPE_BOOLEAN,
}

Definition at line 41 of file fl_settings_portal.cc.

                                           {
    kGnomeDesktopInterface,
    "enable-animations",
    G_VARIANT_TYPE_BOOLEAN,
};

Referenced by fl_settings_portal_get_enable_animations().

kGnomeA11yInterface

constexpr char kGnomeA11yInterface[]

staticconstexpr

Initial value:

=
    "org.gnome.desktop.a11y.interface"

Definition at line 27 of file fl_settings_portal.cc.

kGnomeDesktopInterface

constexpr char kGnomeDesktopInterface[] = "org.gnome.desktop.interface"

staticconstexpr

Definition at line 35 of file fl_settings_portal.cc.

kGtkTheme

const FlSetting kGtkTheme

static

Initial value:

= {
    kGnomeDesktopInterface,
    "gtk-theme",
    G_VARIANT_TYPE_STRING,
}

Definition at line 46 of file fl_settings_portal.cc.

                                   {
    kGnomeDesktopInterface,
    "gtk-theme",
    G_VARIANT_TYPE_STRING,
};

Referenced by fl_settings_portal_get_color_scheme().

kGtkThemeDarkSuffix

constexpr char kGtkThemeDarkSuffix[] = "-dark"

staticconstexpr

Definition at line 63 of file fl_settings_portal.cc.

Referenced by fl_settings_portal_get_color_scheme().

kHighContrast

const FlSetting kHighContrast

static

Initial value:

= {
    kGnomeA11yInterface,
    "high-contrast",
    G_VARIANT_TYPE_BOOLEAN,
}

Definition at line 29 of file fl_settings_portal.cc.

                                       {
    kGnomeA11yInterface,
    "high-contrast",
    G_VARIANT_TYPE_BOOLEAN,
};

Referenced by fl_settings_portal_get_high_contrast().

kPortalName

constexpr char kPortalName[] = "org.freedesktop.portal.Desktop"

staticconstexpr

Definition at line 10 of file fl_settings_portal.cc.

Referenced by fl_settings_portal_start().

kPortalPath

constexpr char kPortalPath[] = "/org/freedesktop/portal/desktop"

staticconstexpr

Definition at line 11 of file fl_settings_portal.cc.

Referenced by fl_settings_portal_start().

kPortalSettings

constexpr char kPortalSettings[] = "org.freedesktop.portal.Settings"

staticconstexpr

Definition at line 12 of file fl_settings_portal.cc.

Referenced by fl_settings_portal_start().

kTextScalingFactor

const FlSetting kTextScalingFactor

static

Initial value:

= {
    kGnomeDesktopInterface,
    "text-scaling-factor",
    G_VARIANT_TYPE_DOUBLE,
}

Definition at line 51 of file fl_settings_portal.cc.

                                            {
    kGnomeDesktopInterface,
    "text-scaling-factor",
    G_VARIANT_TYPE_DOUBLE,
};

Referenced by fl_settings_portal_get_text_scaling_factor().

kXdgAppearance

constexpr char kXdgAppearance[] = "org.freedesktop.appearance"

staticconstexpr

Definition at line 20 of file fl_settings_portal.cc.