mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-02-23 18:52:09 +01:00
3a113699d7
The RestartData property on the org.gtk.Application interface can be used by session services to save some data to disk should the application disappear. The application would call g_application_set_restart_data() when the state of the application changes, with enough information for the application to restart itself in the same "position". FIXME: [ ] API docs [ ] note about restart data size [ ] have one example implementation of the session side One idea would be for xdg-desktop-portal to save a stringified RestartData to ~/.var/app/$ID/config/state.gvariant if none empty when the application disappears from the bus. Questions: - Can we enforce to only do this for unique applications? - Can we detect applications leaving the bus suddenly, or do we want to rely on them clearing RestartData if they're "done" (or should they always save state, *some* state) - Should we implement this via org.gnome.SessionManager.Client and the app calling out to gnome-session instead? - Or is this API fine, and gnome-session can do what xdg-desktop-portal does above?
314 lines
17 KiB
C
314 lines
17 KiB
C
/*
|
||
* Copyright © 2010 Codethink Limited
|
||
*
|
||
* SPDX-License-Identifier: LGPL-2.1-or-later
|
||
*
|
||
* This library is free software; you can redistribute it and/or
|
||
* modify it under the terms of the GNU Lesser General Public
|
||
* License as published by the Free Software Foundation; either
|
||
* version 2.1 of the License, or (at your option) any later version.
|
||
*
|
||
* This library is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||
* Lesser General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU Lesser General
|
||
* Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
||
*
|
||
* Authors: Ryan Lortie <desrt@desrt.ca>
|
||
*/
|
||
|
||
#ifndef __G_APPLICATION_H__
|
||
#define __G_APPLICATION_H__
|
||
|
||
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
|
||
#error "Only <gio/gio.h> can be included directly."
|
||
#endif
|
||
|
||
#include <gio/giotypes.h>
|
||
|
||
G_BEGIN_DECLS
|
||
|
||
#define G_TYPE_APPLICATION (g_application_get_type ())
|
||
#define G_APPLICATION(inst) (G_TYPE_CHECK_INSTANCE_CAST ((inst), \
|
||
G_TYPE_APPLICATION, GApplication))
|
||
#define G_APPLICATION_CLASS(class) (G_TYPE_CHECK_CLASS_CAST ((class), \
|
||
G_TYPE_APPLICATION, GApplicationClass))
|
||
#define G_IS_APPLICATION(inst) (G_TYPE_CHECK_INSTANCE_TYPE ((inst), G_TYPE_APPLICATION))
|
||
#define G_IS_APPLICATION_CLASS(class) (G_TYPE_CHECK_CLASS_TYPE ((class), G_TYPE_APPLICATION))
|
||
#define G_APPLICATION_GET_CLASS(inst) (G_TYPE_INSTANCE_GET_CLASS ((inst), \
|
||
G_TYPE_APPLICATION, GApplicationClass))
|
||
|
||
typedef struct _GApplicationPrivate GApplicationPrivate;
|
||
typedef struct _GApplicationClass GApplicationClass;
|
||
|
||
struct _GApplication
|
||
{
|
||
/*< private >*/
|
||
GObject parent_instance;
|
||
|
||
GApplicationPrivate *priv;
|
||
};
|
||
|
||
struct _GApplicationClass
|
||
{
|
||
/*< private >*/
|
||
GObjectClass parent_class;
|
||
|
||
/*< public >*/
|
||
/* signals */
|
||
void (* startup) (GApplication *application);
|
||
|
||
void (* activate) (GApplication *application);
|
||
|
||
void (* open) (GApplication *application,
|
||
GFile **files,
|
||
gint n_files,
|
||
const gchar *hint);
|
||
|
||
int (* command_line) (GApplication *application,
|
||
GApplicationCommandLine *command_line);
|
||
|
||
/* vfuncs */
|
||
|
||
/**
|
||
* GApplicationClass::local_command_line:
|
||
* @application: a #GApplication
|
||
* @arguments: (inout) (array zero-terminated=1): array of command line arguments
|
||
* @exit_status: (out): exit status to fill after processing the command line.
|
||
*
|
||
* This virtual function is always invoked in the local instance. It
|
||
* gets passed a pointer to a %NULL-terminated copy of @argv and is
|
||
* expected to remove arguments that it handled (shifting up remaining
|
||
* arguments).
|
||
*
|
||
* The last argument to local_command_line() is a pointer to the @status
|
||
* variable which can used to set the exit status that is returned from
|
||
* g_application_run().
|
||
*
|
||
* See g_application_run() for more details on #GApplication startup.
|
||
*
|
||
* Returns: %TRUE if the commandline has been completely handled
|
||
*/
|
||
gboolean (* local_command_line) (GApplication *application,
|
||
gchar ***arguments,
|
||
int *exit_status);
|
||
|
||
/* @platform_data comes from an external process and is untrusted. All value types
|
||
* must be validated before being used. */
|
||
void (* before_emit) (GApplication *application,
|
||
GVariant *platform_data);
|
||
/* Same as for @before_emit. */
|
||
void (* after_emit) (GApplication *application,
|
||
GVariant *platform_data);
|
||
void (* add_platform_data) (GApplication *application,
|
||
GVariantBuilder *builder);
|
||
void (* quit_mainloop) (GApplication *application);
|
||
void (* run_mainloop) (GApplication *application);
|
||
void (* shutdown) (GApplication *application);
|
||
|
||
gboolean (* dbus_register) (GApplication *application,
|
||
GDBusConnection *connection,
|
||
const gchar *object_path,
|
||
GError **error);
|
||
void (* dbus_unregister) (GApplication *application,
|
||
GDBusConnection *connection,
|
||
const gchar *object_path);
|
||
gint (* handle_local_options)(GApplication *application,
|
||
GVariantDict *options);
|
||
gboolean (* name_lost) (GApplication *application);
|
||
|
||
/**
|
||
* GApplicationClass::build_restart_data:
|
||
* @application: a #GApplication
|
||
* @out_tag: (optional) (nullable) (out) (transfer full): return location for
|
||
* a tag to version the restart data, or %NULL to ignore; the returned tag
|
||
* may be %NULL if no restart data is being returned
|
||
*
|
||
* Serialize the key parts of the application’s state so that it can be saved
|
||
* as restart data.
|
||
*
|
||
* The returned #GVariant can have any type which is valid to send over D-Bus.
|
||
*
|
||
* Returns: (transfer full) (nullable): restart data for @application; this
|
||
* may be a floating #GVariant
|
||
*
|
||
* Since: 2.78
|
||
*/
|
||
GVariant *(* build_restart_data) (GApplication *application,
|
||
char **out_tag);
|
||
|
||
/**
|
||
* GApplicationClass::consume_restart_data:
|
||
* @application: a #GApplication
|
||
* @tag: (nullable): a tag to version the restart data, or %NULL if none was
|
||
* set
|
||
* @data: (not nullable): the restart data; this is guaranteed to not be
|
||
* floating
|
||
*
|
||
* Apply the restart data to the application’s state, to restore the saved
|
||
* state.
|
||
*
|
||
* This will typically be called early in the lifetime of @application, so
|
||
* that it can initialize its state correctly according to @data.
|
||
*
|
||
* It will not be called if there is no restart data to load.
|
||
*
|
||
* Implementations should check that @tag matches what they expect (typically
|
||
* the current application version), and may discard the @data if there is a
|
||
* mismatch. This will typically mean that @data dates from a previous version
|
||
* of the application, and may not be compatible.
|
||
*
|
||
* Since: 2.78
|
||
*/
|
||
void (* consume_restart_data)(GApplication *application,
|
||
const char *tag,
|
||
GVariant *data);
|
||
|
||
/*< private >*/
|
||
gpointer padding[5];
|
||
};
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
GType g_application_get_type (void) G_GNUC_CONST;
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
gboolean g_application_id_is_valid (const gchar *application_id);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
GApplication * g_application_new (const gchar *application_id,
|
||
GApplicationFlags flags);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
const gchar * g_application_get_application_id (GApplication *application);
|
||
GIO_AVAILABLE_IN_ALL
|
||
void g_application_set_application_id (GApplication *application,
|
||
const gchar *application_id);
|
||
|
||
GIO_AVAILABLE_IN_2_34
|
||
GDBusConnection * g_application_get_dbus_connection (GApplication *application);
|
||
GIO_AVAILABLE_IN_2_34
|
||
const gchar * g_application_get_dbus_object_path (GApplication *application);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
guint g_application_get_inactivity_timeout (GApplication *application);
|
||
GIO_AVAILABLE_IN_ALL
|
||
void g_application_set_inactivity_timeout (GApplication *application,
|
||
guint inactivity_timeout);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
GApplicationFlags g_application_get_flags (GApplication *application);
|
||
GIO_AVAILABLE_IN_ALL
|
||
void g_application_set_flags (GApplication *application,
|
||
GApplicationFlags flags);
|
||
|
||
GIO_AVAILABLE_IN_2_42
|
||
const gchar * g_application_get_resource_base_path (GApplication *application);
|
||
GIO_AVAILABLE_IN_2_42
|
||
void g_application_set_resource_base_path (GApplication *application,
|
||
const gchar *resource_path);
|
||
|
||
GIO_DEPRECATED
|
||
void g_application_set_action_group (GApplication *application,
|
||
GActionGroup *action_group);
|
||
|
||
GIO_AVAILABLE_IN_2_40
|
||
void g_application_add_main_option_entries (GApplication *application,
|
||
const GOptionEntry *entries);
|
||
|
||
GIO_AVAILABLE_IN_2_42
|
||
void g_application_add_main_option (GApplication *application,
|
||
const char *long_name,
|
||
char short_name,
|
||
GOptionFlags flags,
|
||
GOptionArg arg,
|
||
const char *description,
|
||
const char *arg_description);
|
||
GIO_AVAILABLE_IN_2_40
|
||
void g_application_add_option_group (GApplication *application,
|
||
GOptionGroup *group);
|
||
GIO_AVAILABLE_IN_2_56
|
||
void g_application_set_option_context_parameter_string (GApplication *application,
|
||
const gchar *parameter_string);
|
||
GIO_AVAILABLE_IN_2_56
|
||
void g_application_set_option_context_summary (GApplication *application,
|
||
const gchar *summary);
|
||
GIO_AVAILABLE_IN_2_56
|
||
void g_application_set_option_context_description (GApplication *application,
|
||
const gchar *description);
|
||
GIO_AVAILABLE_IN_ALL
|
||
gboolean g_application_get_is_registered (GApplication *application);
|
||
GIO_AVAILABLE_IN_ALL
|
||
gboolean g_application_get_is_remote (GApplication *application);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
gboolean g_application_register (GApplication *application,
|
||
GCancellable *cancellable,
|
||
GError **error);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
void g_application_hold (GApplication *application);
|
||
GIO_AVAILABLE_IN_ALL
|
||
void g_application_release (GApplication *application);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
void g_application_activate (GApplication *application);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
void g_application_open (GApplication *application,
|
||
GFile **files,
|
||
gint n_files,
|
||
const gchar *hint);
|
||
|
||
GIO_AVAILABLE_IN_ALL
|
||
int g_application_run (GApplication *application,
|
||
int argc,
|
||
char **argv);
|
||
|
||
GIO_AVAILABLE_IN_2_32
|
||
void g_application_quit (GApplication *application);
|
||
|
||
GIO_AVAILABLE_IN_2_32
|
||
GApplication * g_application_get_default (void);
|
||
GIO_AVAILABLE_IN_2_32
|
||
void g_application_set_default (GApplication *application);
|
||
|
||
GIO_AVAILABLE_IN_2_38
|
||
void g_application_mark_busy (GApplication *application);
|
||
GIO_AVAILABLE_IN_2_38
|
||
void g_application_unmark_busy (GApplication *application);
|
||
GIO_AVAILABLE_IN_2_44
|
||
gboolean g_application_get_is_busy (GApplication *application);
|
||
|
||
GIO_AVAILABLE_IN_2_40
|
||
void g_application_send_notification (GApplication *application,
|
||
const gchar *id,
|
||
GNotification *notification);
|
||
GIO_AVAILABLE_IN_2_40
|
||
void g_application_withdraw_notification (GApplication *application,
|
||
const gchar *id);
|
||
|
||
GIO_AVAILABLE_IN_2_44
|
||
void g_application_bind_busy_property (GApplication *application,
|
||
gpointer object,
|
||
const gchar *property);
|
||
|
||
GIO_AVAILABLE_IN_2_44
|
||
void g_application_unbind_busy_property (GApplication *application,
|
||
gpointer object,
|
||
const gchar *property);
|
||
|
||
GIO_AVAILABLE_IN_2_78
|
||
gboolean g_application_get_supports_restart_data (GApplication *application);
|
||
GIO_AVAILABLE_IN_2_78
|
||
void g_application_consume_restart_data (GApplication *application,
|
||
const char *tag,
|
||
GVariant *data);
|
||
GIO_AVAILABLE_IN_2_78
|
||
void g_application_notify_restart_data_changed (GApplication *application);
|
||
|
||
G_END_DECLS
|
||
|
||
#endif /* __G_APPLICATION_H__ */
|