/* * Copyright © 2010 Codethink Limited * * This program 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 of the licence 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, write to the * Free Software Foundation, Inc., 59 Temple Place, Suite 330, * Boston, MA 02111-1307, USA. * * Authors: Ryan Lortie */ /* Prologue {{{1 */ #include "config.h" #include "gapplication.h" #include "gapplicationcommandline.h" #include "gapplicationimpl.h" #include "gactiongroup.h" #include "gioenumtypes.h" #include "gio-marshal.h" #include "gioenums.h" #include "gfile.h" #include "glibintl.h" #include /** * SECTION: gapplication * @title: GApplication * @short_description: Core application class * * A #GApplication is the foundation of an application, unique for a * given application identifier. The GApplication class wraps some * low-level platform-specific services and is intended to act as the * foundation for higher-level application classes such as * #GtkApplication or #MxApplication. In general, you should not use * this class outside of a higher level framework. * * One of the core features that GApplication provides is process * uniqueness, in the context of a "session". The session concept is * platform-dependent, but corresponds roughly to a graphical desktop * login. When your application is launched again, its arguments * are passed through platform communication to the already running * program. The already running instance of the program is called the * primary instance. * * Before using GApplication, you must choose an "application identifier". * The expected form of an application identifier is very close to that of * of a DBus bus name. * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator". * For details on valid application identifiers, see * g_application_id_is_valid(). * * GApplication provides convenient life cycle management by maintaining * a use count for the primary application instance. * The use count can be changed using g_application_hold() and * g_application_release(). If it drops to zero, the application exits. * * Opening files with a GApplication * * * FIXME: MISSING XINCLUDE CONTENT * * * */ struct _GApplicationPrivate { GApplicationFlags flags; gchar *id; GActionGroup *actions; GMainLoop *mainloop; guint inactivity_timeout_id; guint inactivity_timeout; guint use_count; guint is_registered : 1; guint is_remote : 1; GHashTable *remote_actions; /* string -> RemoteActionInfo */ GApplicationImpl *impl; }; enum { PROP_NONE, PROP_APPLICATION_ID, PROP_FLAGS, PROP_IS_REGISTERED, PROP_IS_REMOTE, PROP_INACTIVITY_TIMEOUT, PROP_ACTION_GROUP }; enum { SIGNAL_STARTUP, SIGNAL_ACTIVATE, SIGNAL_OPEN, SIGNAL_ACTION, SIGNAL_COMMAND_LINE, NR_SIGNALS }; static guint g_application_signals[NR_SIGNALS]; static void g_application_action_group_iface_init (GActionGroupInterface *); G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT, G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)) /* vfunc defaults {{{1 */ static void g_application_real_before_emit (GApplication *application, GVariant *platform_data) { } static void g_application_real_after_emit (GApplication *application, GVariant *platform_data) { } static void g_application_real_startup (GApplication *application) { } static void g_application_real_activate (GApplication *application) { if (!g_signal_has_handler_pending (application, g_application_signals[SIGNAL_ACTIVATE], 0, TRUE)) { static gboolean warned; if (warned) return; g_warning ("Your application does not implement " "g_application_activate() and has no handlers connected " "to the 'activate' signal. It should do one of these."); warned = TRUE; } } static void g_application_real_open (GApplication *application, GFile **files, gint n_files, const gchar *hint) { if (!g_signal_has_handler_pending (application, g_application_signals[SIGNAL_OPEN], 0, TRUE)) { static gboolean warned; if (warned) return; g_warning ("Your application claims to support opening files " "but does not implement g_application_open() and has no " "handlers connected to the 'open' signal."); warned = TRUE; } } static int g_application_real_command_line (GApplication *application, GApplicationCommandLine *cmdline) { static gboolean warned; if (warned) return 1; g_warning ("Your application claims to support custom command line " "handling but does not implement g_application_command_line() " "and has no handlers connected to the 'command-line' signal."); warned = TRUE; return 1; } static gboolean g_application_real_local_command_line (GApplication *application, gchar ***arguments, int *exit_status) { if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE) return FALSE; else { GError *error = NULL; gint n_args; if (!g_application_register (application, NULL, &error)) { g_critical ("%s", error->message); g_error_free (error); *exit_status = 1; return TRUE; } n_args = g_strv_length (*arguments); if (application->priv->flags & G_APPLICATION_IS_SERVICE) { if ((*exit_status = n_args > 1)) { g_printerr ("GApplication service mode takes no arguments.\n"); application->priv->flags &= ~G_APPLICATION_IS_SERVICE; } return TRUE; } if (n_args <= 1) { g_application_activate (application); *exit_status = 0; } else { if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN) { g_critical ("This application can not open files."); *exit_status = 1; } else { GFile **files; gint n_files; gint i; n_files = n_args - 1; files = g_new (GFile *, n_files); for (i = 0; i < n_files; i++) files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]); g_application_open (application, files, n_files, ""); for (i = 0; i < n_files; i++) g_object_unref (files[i]); g_free (files); *exit_status = 0; } } return TRUE; } } static void g_application_real_add_platform_data (GApplication *application, GVariantBuilder *builder) { } static void g_application_real_quit_mainloop (GApplication *application) { if (application->priv->mainloop != NULL) g_main_loop_quit (application->priv->mainloop); } static void g_application_real_run_mainloop (GApplication *application) { if (application->priv->mainloop == NULL) application->priv->mainloop = g_main_loop_new (NULL, FALSE); g_main_loop_run (application->priv->mainloop); } /* GObject implementation stuff {{{1 */ static void g_application_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) { GApplication *application = G_APPLICATION (object); switch (prop_id) { case PROP_APPLICATION_ID: g_application_set_application_id (application, g_value_get_string (value)); break; case PROP_FLAGS: g_application_set_flags (application, g_value_get_flags (value)); break; case PROP_INACTIVITY_TIMEOUT: g_application_set_inactivity_timeout (application, g_value_get_uint (value)); break; case PROP_ACTION_GROUP: g_application_set_action_group (application, g_value_get_object (value)); break; default: g_assert_not_reached (); } } /** * g_application_set_action_group: * @application: a #GApplication * @action_group: a #GActionGroup, or %NULL * * Sets or unsets the group of actions associated with the application. * * These actions are the actions that can be remotely invoked. * * It is an error to call this function after the application has been * registered. * * Since: 2.28 **/ void g_application_set_action_group (GApplication *application, GActionGroup *action_group) { g_return_if_fail (G_IS_APPLICATION (application)); g_return_if_fail (!application->priv->is_registered); if (application->priv->actions != NULL) g_object_unref (application->priv->actions); application->priv->actions = action_group; if (application->priv->actions != NULL) g_object_ref (application->priv->actions); } static void g_application_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) { GApplication *application = G_APPLICATION (object); switch (prop_id) { case PROP_APPLICATION_ID: g_value_set_string (value, g_application_get_application_id (application)); break; case PROP_FLAGS: g_value_set_flags (value, g_application_get_flags (application)); break; case PROP_IS_REGISTERED: g_value_set_boolean (value, g_application_get_is_registered (application)); break; case PROP_IS_REMOTE: g_value_set_boolean (value, g_application_get_is_remote (application)); break; case PROP_INACTIVITY_TIMEOUT: g_value_set_uint (value, g_application_get_inactivity_timeout (application)); break; default: g_assert_not_reached (); } } static void g_application_constructed (GObject *object) { GApplication *application = G_APPLICATION (object); g_assert (application->priv->id != NULL); } static void g_application_finalize (GObject *object) { GApplication *application = G_APPLICATION (object); if (application->priv->impl) g_application_impl_destroy (application->priv->impl); g_free (application->priv->id); if (application->priv->mainloop) g_main_loop_unref (application->priv->mainloop); G_OBJECT_CLASS (g_application_parent_class) ->finalize (object); } static void g_application_init (GApplication *application) { application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application, G_TYPE_APPLICATION, GApplicationPrivate); } static void g_application_class_init (GApplicationClass *class) { GObjectClass *object_class = G_OBJECT_CLASS (class); object_class->constructed = g_application_constructed; object_class->finalize = g_application_finalize; object_class->get_property = g_application_get_property; object_class->set_property = g_application_set_property; class->before_emit = g_application_real_before_emit; class->after_emit = g_application_real_after_emit; class->startup = g_application_real_startup; class->activate = g_application_real_activate; class->open = g_application_real_open; class->command_line = g_application_real_command_line; class->local_command_line = g_application_real_local_command_line; class->add_platform_data = g_application_real_add_platform_data; class->quit_mainloop = g_application_real_quit_mainloop; class->run_mainloop = g_application_real_run_mainloop; g_object_class_install_property (object_class, PROP_APPLICATION_ID, g_param_spec_string ("application-id", P_("Application identifier"), P_("The unique identifier for the application"), NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (object_class, PROP_FLAGS, g_param_spec_flags ("flags", P_("Application flags"), P_("Flags specifying the behaviour of the application"), G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (object_class, PROP_IS_REGISTERED, g_param_spec_boolean ("is-registered", P_("Is registered"), P_("If g_application_register() has been called"), FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (object_class, PROP_IS_REMOTE, g_param_spec_boolean ("is-remote", P_("Is remote"), P_("If this application instance is remote"), FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT, g_param_spec_uint ("inactivity-timeout", P_("Inactivity timeout"), P_("Iime (ms) to stay alive after becoming idle"), 0, G_MAXUINT, 0, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS)); g_object_class_install_property (object_class, PROP_ACTION_GROUP, g_param_spec_object ("action-group", P_("Action group"), P_("The group of actions that the application exports"), G_TYPE_ACTION_GROUP, G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS)); /** * GApplication::startup: * @application: the application * * The ::startup signal is emitted on the primary instance immediately * after registration. See g_activation_register(). */ g_application_signals[SIGNAL_STARTUP] = g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GApplicationClass, startup), NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); /** * GApplication::activate: * @application: the application * * The ::activate signal is emitted on the primary instance when an * activation occurs. See g_application_activate(). */ g_application_signals[SIGNAL_ACTIVATE] = g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GApplicationClass, activate), NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0); /** * GApplication::open: * @application: the application * @files: an array of #GFile objects * @n_files: the length of @files * @hint: a hint provided by the calling instance * * The ::open signal is emitted on the primary instance when there are * files to open. See g_application_open() for more information. */ g_application_signals[SIGNAL_OPEN] = g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GApplicationClass, open), NULL, NULL, _gio_marshal_VOID__POINTER_INT_STRING, G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING); /** * GApplication::command-line: * @application: the application * @command_line: a #GApplicationCommandLine representing the * passed commandline * * The ::command-line signal is emitted on the primary instance when * a commandline is not handled locally. See g_application_run() for * more information. */ g_application_signals[SIGNAL_COMMAND_LINE] = g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST, G_STRUCT_OFFSET (GApplicationClass, command_line), g_signal_accumulator_first_wins, NULL, _gio_marshal_INT__OBJECT, G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE); g_type_class_add_private (class, sizeof (GApplicationPrivate)); } static GVariant * get_platform_data (GApplication *application) { GVariantBuilder *builder; GVariant *result; builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}")); { gchar *cwd = g_get_current_dir (); g_variant_builder_add (builder, "{sv}", "cwd", g_variant_new_bytestring (cwd)); g_free (cwd); } if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT) { gchar **envp = g_get_environ (); g_variant_builder_add (builder, "{sv}", "environ", g_variant_new_strv ((const gchar **) envp, -1)); g_strfreev (envp); } G_APPLICATION_GET_CLASS (application)-> add_platform_data (application, builder); result = g_variant_builder_end (builder); g_variant_builder_unref (builder); return result; } /* Application ID validity {{{1 */ /** * g_application_id_is_valid: * @application_id: a potential application identifier * @returns: %TRUE if @application_id is valid * * Checks if @application_id is a valid application identifier. * * A valid ID is required for calls to g_application_new() and * g_application_set_application_id(). * * For convenience, the restrictions on application identifiers are * reproduced here: * * Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-" and must not begin with a digit. * Application identifiers must contain at least one '.' (period) character (and thus at least two elements). * Application identifiers must not begin with a '.' (period) character. * Application identifiers must not contain consecutive '.' (period) characters. * Application identifiers must not exceed 255 characters. * **/ gboolean g_application_id_is_valid (const gchar *application_id) { gboolean allow_dot; if (strlen (application_id) > 255) return FALSE; if (!g_ascii_isalpha (*application_id)) return FALSE; application_id++; allow_dot = FALSE; for (; *application_id; application_id++) { if (g_ascii_isalnum (*application_id) || (*application_id == '-') || (*application_id == '_')) allow_dot = TRUE; else if (allow_dot && *application_id == '.') allow_dot = FALSE; else return FALSE; } return TRUE; } /* Public Constructor {{{1 */ /** * g_application_new: * @application_id: the application id * @flags: the application flags * @returns: a new #GApplication instance * * Creates a new #GApplication instance. * * This function calls g_type_init() for you. * * The application id must be valid. See g_application_id_is_valid(). **/ GApplication * g_application_new (const gchar *application_id, GApplicationFlags flags) { g_return_val_if_fail (g_application_id_is_valid (application_id), NULL); g_type_init (); return g_object_new (G_TYPE_APPLICATION, "application-id", application_id, "flags", flags, NULL); } /* Simple get/set: application id, flags, inactivity timeout {{{1 */ /** * g_application_get_application_id: * @application: a #GApplication * @returns: the identifier for @application, owned by @application * * Gets the unique identifier for @application. * * Since: 2.28 **/ const gchar * g_application_get_application_id (GApplication *application) { g_return_val_if_fail (G_IS_APPLICATION (application), NULL); return application->priv->id; } /** * g_application_set_application_id: * @application: a #GApplication * @application_id: the identifier for @application * * Sets the unique identifier for @application. * * The application id can only be modified if @application has not yet * been registered. * * The application id must be valid. See g_application_id_is_valid(). * * Since: 2.28 **/ void g_application_set_application_id (GApplication *application, const gchar *application_id) { g_return_if_fail (G_IS_APPLICATION (application)); if (g_strcmp0 (application->priv->id, application_id) != 0) { g_return_if_fail (g_application_id_is_valid (application_id)); g_return_if_fail (!application->priv->is_registered); g_free (application->priv->id); application->priv->id = g_strdup (application_id); g_object_notify (G_OBJECT (application), "application-id"); } } /** * g_application_get_flags: * @application: a #GApplication * @returns: the flags for @application * * Gets the flags for @application. * * See #GApplicationFlags. * * Since: 2.28 **/ GApplicationFlags g_application_get_flags (GApplication *application) { g_return_val_if_fail (G_IS_APPLICATION (application), 0); return application->priv->flags; } /** * g_application_set_flags: * @application: a #GApplication * @flags: the flags for @application * * Sets the flags for @application. * * The flags can only be modified if @application has not yet been * registered. * * See #GApplicationFlags. * * Since: 2.28 **/ void g_application_set_flags (GApplication *application, GApplicationFlags flags) { g_return_if_fail (G_IS_APPLICATION (application)); if (application->priv->flags != flags) { g_return_if_fail (!application->priv->is_registered); application->priv->flags = flags; g_object_notify (G_OBJECT (application), "flags"); } } /** * g_application_get_inactivity_timeout: * @application: a #GApplication * * Gets the current inactivity timeout for the application. * * This is the amount of time (in milliseconds) after the last call to * g_application_release() before the application stops running. * * Returns: the timeout, in milliseconds * * Since: 2.28 **/ guint g_application_get_inactivity_timeout (GApplication *application) { g_return_val_if_fail (G_IS_APPLICATION (application), 0); return application->priv->inactivity_timeout; } /** * g_application_set_inactivity_timeout: * @application: a #GApplication * @inactivity_timeout: the timeout, in milliseconds * * Sets the current inactivity timeout for the application. * * This is the amount of time (in milliseconds) after the last call to * g_application_release() before the application stops running. * * This call has no side effects of its own. The value set here is only * used for next time g_application_release() drops the use count to * zero. Any timeouts currently in progress are not impacted. * * Returns: the timeout, in milliseconds * * Since: 2.28 **/ void g_application_set_inactivity_timeout (GApplication *application, guint inactivity_timeout) { g_return_if_fail (G_IS_APPLICATION (application)); if (application->priv->inactivity_timeout != inactivity_timeout) { application->priv->inactivity_timeout = inactivity_timeout; g_object_notify (G_OBJECT (application), "inactivity-timeout"); } } /* Read-only property getters (is registered, is remote) {{{1 */ /** * g_application_get_is_registered: * @application: a #GApplication * @returns: %TRUE if @application is registered * * Checks if @application is registered. * * An application is registered if g_application_register() has been * successfully called. * * Since: 2.28 **/ gboolean g_application_get_is_registered (GApplication *application) { g_return_val_if_fail (G_IS_APPLICATION (application), FALSE); return application->priv->is_registered; } /** * g_application_get_is_remote: * @application: a #GApplication * @returns: %TRUE if @application is remote * * Checks if @application is remote. * * If @application is remote then it means that another instance of * application already exists (the 'primary' instance). Calls to * perform actions on @application will result in the actions being * performed by the primary instance. * * The value of this property can not be accessed before * g_application_register() has been called. See * g_application_get_is_registered(). * * Since: 2.28 **/ gboolean g_application_get_is_remote (GApplication *application) { g_return_val_if_fail (G_IS_APPLICATION (application), FALSE); g_return_val_if_fail (application->priv->is_registered, FALSE); return application->priv->is_remote; } /* Register {{{1 */ /** * g_application_register: * @application: a #GApplication * @cancellable: a #GCancellable, or %NULL * @error: a pointer to a NULL #GError, or %NULL * @returns: %TRUE if registration succeeded * * Attempts registration of the application. * * This is the point at which the application discovers if it is the * primary instance or merely acting as a remote for an already-existing * primary instance. * * If the application has already been registered then %TRUE is * returned with no work performed. * * The #GApplication::startup signal is emitted if registration succeeds * and @application is the primary instance. * * In the event of an error (such as @cancellable being cancelled, or a * failure to connect to the session bus), %FALSE is returned and @error * is set appropriately. * * Note: the return value of this function is not an indicator that this * instance is or is not the primary instance of the application. See * g_application_get_is_remote() for that. * * Since: 2.28 **/ gboolean g_application_register (GApplication *application, GCancellable *cancellable, GError **error) { g_return_val_if_fail (G_IS_APPLICATION (application), FALSE); if (!application->priv->is_registered) { application->priv->impl = g_application_impl_register (application, application->priv->id, application->priv->flags, &application->priv->remote_actions, cancellable, error); if (application->priv->impl == NULL) return FALSE; application->priv->is_remote = application->priv->remote_actions != NULL; application->priv->is_registered = TRUE; g_object_notify (G_OBJECT (application), "is-registered"); if (!application->priv->is_remote) g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0); } return TRUE; } /* Hold/release {{{1 */ /** * g_application_hold: * @application: a #GApplication * * Increases the use count of @application. * * Use this function to indicate that the application has a reason to * continue to run. For example, g_application_hold() is called by GTK+ * when a toplevel window is on the screen. * * To cancel the hold, call g_application_release(). **/ void g_application_hold (GApplication *application) { if (application->priv->inactivity_timeout_id) { g_source_remove (application->priv->inactivity_timeout_id); application->priv->inactivity_timeout_id = 0; } application->priv->use_count++; } static gboolean inactivity_timeout_expired (gpointer data) { GApplication *application = G_APPLICATION (data); G_APPLICATION_GET_CLASS (application) ->quit_mainloop (application); return FALSE; } /** * g_application_release: * @application: a #GApplication * * Decrease the use count of @application. * * When the use count reaches zero, the application will stop running. * * Never call this function except to cancel the effect of a previous * call to g_application_hold(). **/ void g_application_release (GApplication *application) { application->priv->use_count--; if (application->priv->use_count == 0) { if (application->priv->inactivity_timeout) application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout, inactivity_timeout_expired, application); else G_APPLICATION_GET_CLASS (application) ->quit_mainloop (application); } } /* Activate, Open {{{1 */ /** * g_application_activate: * @application: a #GApplication * * Activates the application. * * In essence, this results in the #GApplication::activate() signal being * emitted in the primary instance. * * The application must be registered before calling this function. * * Since: 2.28 **/ void g_application_activate (GApplication *application) { g_return_if_fail (G_IS_APPLICATION (application)); g_return_if_fail (application->priv->is_registered); if (application->priv->is_remote) g_application_impl_activate (application->priv->impl, get_platform_data (application)); else g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0); } /** * g_application_open: * @application: a #GApplication * @files: an array of #GFiles to open * @n_files: the length of the @files array * @hint: a hint (or ""), but never %NULL * * Opens the given files. * * In essence, this results in the #GApplication::open signal being emitted * in the primary instance. * * @n_files must be greater than zero. * * @hint is simply passed through to the ::open signal. It is * intended to be used by applications that have multiple modes for * opening files (eg: "view" vs "edit", etc). Unless you have a need * for this functionality, you should use "". * * The application must be registered before calling this function * and it must have the %G_APPLICATION_HANDLES_OPEN flag set. * * Since: 2.28 **/ void g_application_open (GApplication *application, GFile **files, gint n_files, const gchar *hint) { g_return_if_fail (G_IS_APPLICATION (application)); g_return_if_fail (application->priv->flags & G_APPLICATION_HANDLES_OPEN); g_return_if_fail (application->priv->is_registered); if (application->priv->is_remote) g_application_impl_open (application->priv->impl, files, n_files, hint, get_platform_data (application)); else g_signal_emit (application, g_application_signals[SIGNAL_OPEN], 0, files, n_files, hint); } /* Run {{{1 */ /** * g_application_run: * @application: a #GApplication * @argc: the argc from main() * @argv: the argv from main() * @returns: the exit status * * Runs the application. * * This function is intended to be run from main() and its return value * is intended to be returned by main(). * * First, the local_command_line() virtual function is invoked. This * function always runs on the local instance. If that function returns * %FALSE then the application is registered and the #GApplication::command-line * signal is emitted in the primary instance (which may or may not be * this instance). * * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE * flag set then the default implementation of local_command_line() * always returns %FALSE immediately, resulting in the commandline * always being handled in the primary instance. * * Otherwise, the default implementation of local_command_line() tries * to do a couple of things that are probably reasonable for most * applications. First, g_application_register() is called to attempt * to register the application. If that works, then the command line * arguments are inspected. If no commandline arguments are given, then * g_application_activate() is called. If commandline arguments are * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they * are assumed to be filenames and g_application_open() is called. * * If you are interested in doing more complicated local handling of the * commandline then you should implement your own #GApplication subclass * and override local_command_line(). See * for an example. * * If, after the above is done, the use count of the application is zero * then the exit status is returned immediately. If the use count is * non-zero then the mainloop is run until the use count falls to zero, * at which point 0 is returned. * * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at * use count of zero is delayed for a while (ie: the instance stays * around to provide its service to others). * * Since: 2.28 **/ int g_application_run (GApplication *application, int argc, char **argv) { gchar **arguments; int status; gint i; g_return_val_if_fail (G_IS_APPLICATION (application), 1); g_return_val_if_fail (argc == 0 || argv != NULL, 1); arguments = g_new (gchar *, argc + 1); for (i = 0; i < argc; i++) arguments[i] = g_strdup (argv[i]); arguments[i] = NULL; if (g_get_prgname () == NULL && argc > 0) { gchar *prgname; prgname = g_path_get_basename (argv[0]); g_set_prgname (prgname); g_free (prgname); } if (!G_APPLICATION_GET_CLASS (application) ->local_command_line (application, &arguments, &status)) { GError *error = NULL; if (!g_application_register (application, NULL, &error)) { g_printerr ("%s", error->message); g_error_free (error); return 1; } if (application->priv->is_remote) { GVariant *platform_data; platform_data = get_platform_data (application); status = g_application_impl_command_line (application->priv->impl, arguments, platform_data); } else { GApplicationCommandLine *cmdline; GVariant *v; v = g_variant_new_bytestring_array ((const gchar **) arguments, -1); cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE, "arguments", v, NULL); g_signal_emit (application, g_application_signals[SIGNAL_COMMAND_LINE], 0, cmdline, &status); g_object_unref (cmdline); } } g_strfreev (arguments); if (application->priv->flags & G_APPLICATION_IS_SERVICE && application->priv->is_registered && !application->priv->use_count && !application->priv->inactivity_timeout_id) { application->priv->inactivity_timeout_id = g_timeout_add (10000, inactivity_timeout_expired, application); } if (application->priv->use_count || application->priv->inactivity_timeout_id) { G_APPLICATION_GET_CLASS (application) ->run_mainloop (application); status = 0; } if (application->priv->impl) g_application_impl_flush (application->priv->impl); return status; } static gboolean g_application_has_action (GActionGroup *action_group, const gchar *action_name) { GApplication *application = G_APPLICATION (action_group); g_return_val_if_fail (application->priv->is_registered, FALSE); if (application->priv->remote_actions != NULL) return g_hash_table_lookup (application->priv->remote_actions, action_name) != NULL; return application->priv->actions && g_action_group_has_action (application->priv->actions, action_name); } static gchar ** g_application_list_actions (GActionGroup *action_group) { GApplication *application = G_APPLICATION (action_group); g_return_val_if_fail (application->priv->is_registered, NULL); if (application->priv->remote_actions != NULL) { GHashTableIter iter; gint n, i = 0; gchar **keys; gpointer key; n = g_hash_table_size (application->priv->remote_actions); keys = g_new (gchar *, n + 1); g_hash_table_iter_init (&iter, application->priv->remote_actions); while (g_hash_table_iter_next (&iter, &key, NULL)) keys[i++] = g_strdup (key); g_assert_cmpint (i, ==, n); keys[n] = NULL; return keys; } else if (application->priv->actions != NULL) return g_action_group_list_actions (application->priv->actions); else /* empty string array */ return g_new0 (gchar *, 1); } static gboolean g_application_get_action_enabled (GActionGroup *action_group, const gchar *action_name) { GApplication *application = G_APPLICATION (action_group); g_return_val_if_fail (application->priv->actions != NULL, FALSE); g_return_val_if_fail (application->priv->is_registered, FALSE); if (application->priv->remote_actions) { RemoteActionInfo *info; info = g_hash_table_lookup (application->priv->remote_actions, action_name); return info && info->enabled; } return g_action_group_get_action_enabled (application->priv->actions, action_name); } static const GVariantType * g_application_get_action_parameter_type (GActionGroup *action_group, const gchar *action_name) { GApplication *application = G_APPLICATION (action_group); g_return_val_if_fail (application->priv->actions != NULL, NULL); g_return_val_if_fail (application->priv->is_registered, NULL); if (application->priv->remote_actions) { RemoteActionInfo *info; info = g_hash_table_lookup (application->priv->remote_actions, action_name); if (info) return info->parameter_type; else return NULL; } return g_action_group_get_action_parameter_type (application->priv->actions, action_name); } static const GVariantType * g_application_get_action_state_type (GActionGroup *action_group, const gchar *action_name) { GApplication *application = G_APPLICATION (action_group); g_return_val_if_fail (application->priv->actions != NULL, NULL); g_return_val_if_fail (application->priv->is_registered, NULL); if (application->priv->remote_actions) { RemoteActionInfo *info; info = g_hash_table_lookup (application->priv->remote_actions, action_name); if (info && info->state) return g_variant_get_type (info->state); else return NULL; } return g_action_group_get_action_state_type (application->priv->actions, action_name); } static GVariant * g_application_get_action_state (GActionGroup *action_group, const gchar *action_name) { GApplication *application = G_APPLICATION (action_group); g_return_val_if_fail (application->priv->actions != NULL, NULL); g_return_val_if_fail (application->priv->is_registered, NULL); if (application->priv->remote_actions) { RemoteActionInfo *info; info = g_hash_table_lookup (application->priv->remote_actions, action_name); if (info && info->state) return g_variant_ref (info->state); else return NULL; } return g_action_group_get_action_state (application->priv->actions, action_name); } static void g_application_change_action_state (GActionGroup *action_group, const gchar *action_name, GVariant *value) { GApplication *application = G_APPLICATION (action_group); g_return_if_fail (application->priv->is_registered); if (application->priv->is_remote) g_application_impl_change_action_state (application->priv->impl, action_name, value, get_platform_data (application)); else g_action_group_change_action_state (application->priv->actions, action_name, value); } static void g_application_activate_action (GActionGroup *action_group, const gchar *action_name, GVariant *parameter) { GApplication *application = G_APPLICATION (action_group); g_return_if_fail (application->priv->is_registered); if (application->priv->is_remote) g_application_impl_activate_action (application->priv->impl, action_name, parameter, get_platform_data (application)); else g_action_group_activate_action (application->priv->actions, action_name, parameter); } static void g_application_action_group_iface_init (GActionGroupInterface *iface) { iface->has_action = g_application_has_action; iface->list_actions = g_application_list_actions; iface->get_action_enabled = g_application_get_action_enabled; iface->get_action_parameter_type = g_application_get_action_parameter_type; iface->get_action_state_type = g_application_get_action_state_type; iface->get_action_state = g_application_get_action_state; iface->change_action_state = g_application_change_action_state; iface->activate_action = g_application_activate_action; } /* Epilogue {{{1 */ /* vim:set foldmethod=marker: */