2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2 of the licence or (at
7 * your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Authors: Ryan Lortie <desrt@desrt.ca>
25 #include "gapplication.h"
27 #include "gapplicationcommandline.h"
28 #include "gapplicationimpl.h"
29 #include "gactiongroup.h"
30 #include "gsettings.h"
32 #include "gioenumtypes.h"
41 * SECTION:gapplication
42 * @title: GApplication
43 * @short_description: Core application class
45 * A #GApplication is the foundation of an application, unique for a
46 * given application identifier. The GApplication class wraps some
47 * low-level platform-specific services and is intended to act as the
48 * foundation for higher-level application classes such as
49 * #GtkApplication or #MxApplication. In general, you should not use
50 * this class outside of a higher level framework.
52 * One of the core features that GApplication provides is process
53 * uniqueness, in the context of a "session". The session concept is
54 * platform-dependent, but corresponds roughly to a graphical desktop
55 * login. When your application is launched again, its arguments
56 * are passed through platform communication to the already running
57 * program. The already running instance of the program is called the
58 * <firstterm>primary instance</firstterm>.
60 * Before using GApplication, you must choose an "application identifier".
61 * The expected form of an application identifier is very close to that of
62 * of a <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
63 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
64 * For details on valid application identifiers, see
65 * g_application_id_is_valid().
67 * The application identifier is claimed by the application as a
68 * well-known bus name on the user's session bus. This means that the
69 * uniqueness of your application is scoped to the current session. It
70 * also means that your application may provide additional services
71 * (through registration of other object paths) at that bus name.
73 * The registration of these object paths should be done with the shared
74 * GDBus session bus. Note that due to the internal architecture of
75 * GDBus, method calls can be dispatched at any time (even if a main
76 * loop is not running). For this reason, you must ensure that any
77 * object paths that you wish to register are registered before
78 * #GApplication attempts to acquire the bus name of your application
79 * (which happens in g_application_register()). Unfortunately, this
80 * means that you cannot use g_application_get_is_remote() to decide if
81 * you want to register object paths.
83 * GApplication provides convenient life cycle management by maintaining
84 * a <firstterm>use count</firstterm> for the primary application instance.
85 * The use count can be changed using g_application_hold() and
86 * g_application_release(). If it drops to zero, the application exits.
88 * GApplication also implements the #GActionGroup interface and lets you
89 * easily export actions by adding them with g_application_set_action_group().
90 * When invoking an action by calling g_action_group_activate_action() on
91 * the application, it is always invoked in the primary instance.
93 * There is a number of different entry points into a #GApplication:
95 * <listitem>via 'Activate' (i.e. just starting the application)</listitem>
96 * <listitem>via 'Open' (i.e. opening some files)</listitem>
97 * <listitem>by handling a command-line</listitem>
98 * <listitem>via activating an action</listitem>
100 * The #GApplication::startup signal lets you handle the application
101 * initialization for all of these in a single place.
103 * Regardless of which of these entry points is used to start the application,
104 * GApplication passes some <firstterm id="platform-data">platform
105 * data</firstterm> from the launching instance to the primary instance,
106 * in the form of a #GVariant dictionary mapping strings to variants.
107 * To use platform data, override the @before_emit or @after_emit virtual
108 * functions in your #GApplication subclass. When dealing with
109 * #GApplicationCommandline objects, the platform data is directly
110 * available via g_application_command_line_get_cwd(),
111 * g_application_command_line_get_environ() and
112 * g_application_command_line_get_platform_data().
114 * As the name indicates, the platform data may vary depending on the
115 * operating system, but it always includes the current directory (key
116 * "cwd"), and optionally the environment (ie the set of environment
117 * variables and their values) of the calling process (key "environ").
118 * The environment is only added to the platform data if the
119 * #G_APPLICATION_SEND_ENVIONMENT flag is set. GApplication subclasses
120 * can add their own platform data by overriding the @add_platform_data
121 * virtual function. For instance, #GtkApplication adds startup notification
124 * To parse commandline arguments you may handle the
125 * #GApplication::command-line signal or override the local_command_line()
126 * vfunc, to parse them in either the primary instance or the local instance,
129 * <example id="gapplication-example-open"><title>Opening files with a GApplication</title>
131 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-open.c">
132 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
137 * <example id="gapplication-example-actions"><title>A GApplication with actions</title>
139 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-actions.c">
140 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
146 struct _GApplicationPrivate
148 GApplicationFlags flags;
151 GActionGroup *actions;
153 guint inactivity_timeout_id;
154 guint inactivity_timeout;
157 guint is_registered : 1;
159 guint did_startup : 1;
160 guint did_shutdown : 1;
162 GHashTable *remote_actions; /* string -> RemoteActionInfo */
163 GApplicationImpl *impl;
173 PROP_INACTIVITY_TIMEOUT,
188 static guint g_application_signals[NR_SIGNALS];
190 static void g_application_action_group_iface_init (GActionGroupInterface *);
191 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
192 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP,
193 g_application_action_group_iface_init))
195 /* vfunc defaults {{{1 */
197 g_application_real_before_emit (GApplication *application,
198 GVariant *platform_data)
203 g_application_real_after_emit (GApplication *application,
204 GVariant *platform_data)
209 g_application_real_startup (GApplication *application)
211 application->priv->did_startup = TRUE;
215 g_application_real_shutdown (GApplication *application)
217 application->priv->did_shutdown = TRUE;
221 g_application_real_activate (GApplication *application)
223 if (!g_signal_has_handler_pending (application,
224 g_application_signals[SIGNAL_ACTIVATE],
226 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
228 static gboolean warned;
233 g_warning ("Your application does not implement "
234 "g_application_activate() and has no handlers connected "
235 "to the 'activate' signal. It should do one of these.");
241 g_application_real_open (GApplication *application,
246 if (!g_signal_has_handler_pending (application,
247 g_application_signals[SIGNAL_OPEN],
249 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
251 static gboolean warned;
256 g_warning ("Your application claims to support opening files "
257 "but does not implement g_application_open() and has no "
258 "handlers connected to the 'open' signal.");
264 g_application_real_command_line (GApplication *application,
265 GApplicationCommandLine *cmdline)
267 if (!g_signal_has_handler_pending (application,
268 g_application_signals[SIGNAL_COMMAND_LINE],
270 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
272 static gboolean warned;
277 g_warning ("Your application claims to support custom command line "
278 "handling but does not implement g_application_command_line() "
279 "and has no handlers connected to the 'command-line' signal.");
288 g_application_real_local_command_line (GApplication *application,
292 if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
297 GError *error = NULL;
300 if (!g_application_register (application, NULL, &error))
302 g_critical ("%s", error->message);
303 g_error_free (error);
308 n_args = g_strv_length (*arguments);
310 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
312 if ((*exit_status = n_args > 1))
314 g_printerr ("GApplication service mode takes no arguments.\n");
315 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
323 g_application_activate (application);
329 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
331 g_critical ("This application can not open files.");
340 n_files = n_args - 1;
341 files = g_new (GFile *, n_files);
343 for (i = 0; i < n_files; i++)
344 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
346 g_application_open (application, files, n_files, "");
348 for (i = 0; i < n_files; i++)
349 g_object_unref (files[i]);
361 g_application_real_add_platform_data (GApplication *application,
362 GVariantBuilder *builder)
366 /* GObject implementation stuff {{{1 */
368 g_application_set_property (GObject *object,
373 GApplication *application = G_APPLICATION (object);
377 case PROP_APPLICATION_ID:
378 g_application_set_application_id (application,
379 g_value_get_string (value));
383 g_application_set_flags (application, g_value_get_flags (value));
386 case PROP_INACTIVITY_TIMEOUT:
387 g_application_set_inactivity_timeout (application,
388 g_value_get_uint (value));
391 case PROP_ACTION_GROUP:
392 g_application_set_action_group (application,
393 g_value_get_object (value));
397 g_assert_not_reached ();
402 * g_application_set_action_group:
403 * @application: a #GApplication
404 * @action_group: (allow-none): a #GActionGroup, or %NULL
406 * Sets or unsets the group of actions associated with the application.
408 * These actions are the actions that can be remotely invoked.
410 * It is an error to call this function after the application has been
416 g_application_set_action_group (GApplication *application,
417 GActionGroup *action_group)
419 g_return_if_fail (G_IS_APPLICATION (application));
420 g_return_if_fail (!application->priv->is_registered);
422 if (application->priv->actions != NULL)
423 g_object_unref (application->priv->actions);
425 application->priv->actions = action_group;
427 if (application->priv->actions != NULL)
428 g_object_ref (application->priv->actions);
432 g_application_get_property (GObject *object,
437 GApplication *application = G_APPLICATION (object);
441 case PROP_APPLICATION_ID:
442 g_value_set_string (value,
443 g_application_get_application_id (application));
447 g_value_set_flags (value,
448 g_application_get_flags (application));
451 case PROP_IS_REGISTERED:
452 g_value_set_boolean (value,
453 g_application_get_is_registered (application));
457 g_value_set_boolean (value,
458 g_application_get_is_remote (application));
461 case PROP_INACTIVITY_TIMEOUT:
462 g_value_set_uint (value,
463 g_application_get_inactivity_timeout (application));
467 g_assert_not_reached ();
472 g_application_constructed (GObject *object)
474 GApplication *application = G_APPLICATION (object);
476 g_assert (application->priv->id != NULL);
480 g_application_finalize (GObject *object)
482 GApplication *application = G_APPLICATION (object);
484 if (application->priv->impl)
485 g_application_impl_destroy (application->priv->impl);
486 g_free (application->priv->id);
488 G_OBJECT_CLASS (g_application_parent_class)
493 g_application_init (GApplication *application)
495 application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
497 GApplicationPrivate);
501 g_application_class_init (GApplicationClass *class)
503 GObjectClass *object_class = G_OBJECT_CLASS (class);
505 object_class->constructed = g_application_constructed;
506 object_class->finalize = g_application_finalize;
507 object_class->get_property = g_application_get_property;
508 object_class->set_property = g_application_set_property;
510 class->before_emit = g_application_real_before_emit;
511 class->after_emit = g_application_real_after_emit;
512 class->startup = g_application_real_startup;
513 class->shutdown = g_application_real_shutdown;
514 class->activate = g_application_real_activate;
515 class->open = g_application_real_open;
516 class->command_line = g_application_real_command_line;
517 class->local_command_line = g_application_real_local_command_line;
518 class->add_platform_data = g_application_real_add_platform_data;
520 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
521 g_param_spec_string ("application-id",
522 P_("Application identifier"),
523 P_("The unique identifier for the application"),
524 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
525 G_PARAM_STATIC_STRINGS));
527 g_object_class_install_property (object_class, PROP_FLAGS,
528 g_param_spec_flags ("flags",
529 P_("Application flags"),
530 P_("Flags specifying the behaviour of the application"),
531 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
532 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
534 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
535 g_param_spec_boolean ("is-registered",
537 P_("If g_application_register() has been called"),
538 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
540 g_object_class_install_property (object_class, PROP_IS_REMOTE,
541 g_param_spec_boolean ("is-remote",
543 P_("If this application instance is remote"),
544 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
546 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
547 g_param_spec_uint ("inactivity-timeout",
548 P_("Inactivity timeout"),
549 P_("Time (ms) to stay alive after becoming idle"),
551 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
553 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
554 g_param_spec_object ("action-group",
556 P_("The group of actions that the application exports"),
558 G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
561 * GApplication::startup:
562 * @application: the application
564 * The ::startup signal is emitted on the primary instance immediately
565 * after registration. See g_application_register().
567 g_application_signals[SIGNAL_STARTUP] =
568 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
569 G_STRUCT_OFFSET (GApplicationClass, startup),
570 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
573 * GApplication::shutdown:
574 * @application: the application
576 * The ::shutdown signal is emitted only on the registered primary instance
577 * immediately after the main loop terminates.
579 g_application_signals[SIGNAL_SHUTDOWN] =
580 g_signal_new ("shutdown", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
581 G_STRUCT_OFFSET (GApplicationClass, shutdown),
582 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
585 * GApplication::activate:
586 * @application: the application
588 * The ::activate signal is emitted on the primary instance when an
589 * activation occurs. See g_application_activate().
591 g_application_signals[SIGNAL_ACTIVATE] =
592 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
593 G_STRUCT_OFFSET (GApplicationClass, activate),
594 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
598 * GApplication::open:
599 * @application: the application
600 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
601 * @n_files: the length of @files
602 * @hint: a hint provided by the calling instance
604 * The ::open signal is emitted on the primary instance when there are
605 * files to open. See g_application_open() for more information.
607 g_application_signals[SIGNAL_OPEN] =
608 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
609 G_STRUCT_OFFSET (GApplicationClass, open),
611 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
614 * GApplication::command-line:
615 * @application: the application
616 * @command_line: a #GApplicationCommandLine representing the
619 * The ::command-line signal is emitted on the primary instance when
620 * a commandline is not handled locally. See g_application_run() and
621 * the #GApplicationCommandline documentation for more information.
623 * Returns: An integer that is set as the exit status for the calling
624 * process. See g_application_command_line_set_exit_status().
626 g_application_signals[SIGNAL_COMMAND_LINE] =
627 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
628 G_STRUCT_OFFSET (GApplicationClass, command_line),
629 g_signal_accumulator_first_wins, NULL,
631 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
633 g_type_class_add_private (class, sizeof (GApplicationPrivate));
637 get_platform_data (GApplication *application)
639 GVariantBuilder *builder;
642 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
645 gchar *cwd = g_get_current_dir ();
646 g_variant_builder_add (builder, "{sv}", "cwd",
647 g_variant_new_bytestring (cwd));
651 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
656 envp = g_get_environ ();
657 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
660 g_variant_builder_add (builder, "{sv}", "environ", array);
663 G_APPLICATION_GET_CLASS (application)->
664 add_platform_data (application, builder);
666 result = g_variant_builder_end (builder);
667 g_variant_builder_unref (builder);
672 /* Application ID validity {{{1 */
675 * g_application_id_is_valid:
676 * @application_id: a potential application identifier
678 * Checks if @application_id is a valid application identifier.
680 * A valid ID is required for calls to g_application_new() and
681 * g_application_set_application_id().
683 * For convenience, the restrictions on application identifiers are
686 * <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-." and must not begin with a digit.</listitem>
687 * <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least three elements).</listitem>
688 * <listitem>Application identifiers must not begin or end with a '.' (period) character.</listitem>
689 * <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
690 * <listitem>Application identifiers must not exceed 255 characters.</listitem>
693 * Returns: %TRUE if @application_id is valid
696 g_application_id_is_valid (const gchar *application_id)
702 len = strlen (application_id);
707 if (!g_ascii_isalpha (application_id[0]))
710 if (application_id[len-1] == '.')
716 for (; *application_id; application_id++)
718 if (g_ascii_isalnum (*application_id) ||
719 (*application_id == '-') ||
720 (*application_id == '_'))
724 else if (allow_dot && *application_id == '.')
739 /* Public Constructor {{{1 */
742 * @application_id: the application id
743 * @flags: the application flags
745 * Creates a new #GApplication instance.
747 * This function calls g_type_init() for you.
749 * The application id must be valid. See g_application_id_is_valid().
751 * Returns: a new #GApplication instance
754 g_application_new (const gchar *application_id,
755 GApplicationFlags flags)
757 g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
761 return g_object_new (G_TYPE_APPLICATION,
762 "application-id", application_id,
767 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
769 * g_application_get_application_id:
770 * @application: a #GApplication
772 * Gets the unique identifier for @application.
774 * Returns: the identifier for @application, owned by @application
779 g_application_get_application_id (GApplication *application)
781 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
783 return application->priv->id;
787 * g_application_set_application_id:
788 * @application: a #GApplication
789 * @application_id: the identifier for @application
791 * Sets the unique identifier for @application.
793 * The application id can only be modified if @application has not yet
796 * The application id must be valid. See g_application_id_is_valid().
801 g_application_set_application_id (GApplication *application,
802 const gchar *application_id)
804 g_return_if_fail (G_IS_APPLICATION (application));
806 if (g_strcmp0 (application->priv->id, application_id) != 0)
808 g_return_if_fail (g_application_id_is_valid (application_id));
809 g_return_if_fail (!application->priv->is_registered);
811 g_free (application->priv->id);
812 application->priv->id = g_strdup (application_id);
814 g_object_notify (G_OBJECT (application), "application-id");
819 * g_application_get_flags:
820 * @application: a #GApplication
822 * Gets the flags for @application.
824 * See #GApplicationFlags.
826 * Returns: the flags for @application
831 g_application_get_flags (GApplication *application)
833 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
835 return application->priv->flags;
839 * g_application_set_flags:
840 * @application: a #GApplication
841 * @flags: the flags for @application
843 * Sets the flags for @application.
845 * The flags can only be modified if @application has not yet been
848 * See #GApplicationFlags.
853 g_application_set_flags (GApplication *application,
854 GApplicationFlags flags)
856 g_return_if_fail (G_IS_APPLICATION (application));
858 if (application->priv->flags != flags)
860 g_return_if_fail (!application->priv->is_registered);
862 application->priv->flags = flags;
864 g_object_notify (G_OBJECT (application), "flags");
869 * g_application_get_inactivity_timeout:
870 * @application: a #GApplication
872 * Gets the current inactivity timeout for the application.
874 * This is the amount of time (in milliseconds) after the last call to
875 * g_application_release() before the application stops running.
877 * Returns: the timeout, in milliseconds
882 g_application_get_inactivity_timeout (GApplication *application)
884 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
886 return application->priv->inactivity_timeout;
890 * g_application_set_inactivity_timeout:
891 * @application: a #GApplication
892 * @inactivity_timeout: the timeout, in milliseconds
894 * Sets the current inactivity timeout for the application.
896 * This is the amount of time (in milliseconds) after the last call to
897 * g_application_release() before the application stops running.
899 * This call has no side effects of its own. The value set here is only
900 * used for next time g_application_release() drops the use count to
901 * zero. Any timeouts currently in progress are not impacted.
906 g_application_set_inactivity_timeout (GApplication *application,
907 guint inactivity_timeout)
909 g_return_if_fail (G_IS_APPLICATION (application));
911 if (application->priv->inactivity_timeout != inactivity_timeout)
913 application->priv->inactivity_timeout = inactivity_timeout;
915 g_object_notify (G_OBJECT (application), "inactivity-timeout");
918 /* Read-only property getters (is registered, is remote) {{{1 */
920 * g_application_get_is_registered:
921 * @application: a #GApplication
923 * Checks if @application is registered.
925 * An application is registered if g_application_register() has been
926 * successfully called.
928 * Returns: %TRUE if @application is registered
933 g_application_get_is_registered (GApplication *application)
935 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
937 return application->priv->is_registered;
941 * g_application_get_is_remote:
942 * @application: a #GApplication
944 * Checks if @application is remote.
946 * If @application is remote then it means that another instance of
947 * application already exists (the 'primary' instance). Calls to
948 * perform actions on @application will result in the actions being
949 * performed by the primary instance.
951 * The value of this property cannot be accessed before
952 * g_application_register() has been called. See
953 * g_application_get_is_registered().
955 * Returns: %TRUE if @application is remote
960 g_application_get_is_remote (GApplication *application)
962 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
963 g_return_val_if_fail (application->priv->is_registered, FALSE);
965 return application->priv->is_remote;
970 * g_application_register:
971 * @application: a #GApplication
972 * @cancellable: a #GCancellable, or %NULL
973 * @error: a pointer to a NULL #GError, or %NULL
975 * Attempts registration of the application.
977 * This is the point at which the application discovers if it is the
978 * primary instance or merely acting as a remote for an already-existing
979 * primary instance. This is implemented by attempting to acquire the
980 * application identifier as a unique bus name on the session bus using
983 * Due to the internal architecture of GDBus, method calls can be
984 * dispatched at any time (even if a main loop is not running). For
985 * this reason, you must ensure that any object paths that you wish to
986 * register are registered before calling this function.
988 * If the application has already been registered then %TRUE is
989 * returned with no work performed.
991 * The #GApplication::startup signal is emitted if registration succeeds
992 * and @application is the primary instance.
994 * In the event of an error (such as @cancellable being cancelled, or a
995 * failure to connect to the session bus), %FALSE is returned and @error
996 * is set appropriately.
998 * Note: the return value of this function is not an indicator that this
999 * instance is or is not the primary instance of the application. See
1000 * g_application_get_is_remote() for that.
1002 * Returns: %TRUE if registration succeeded
1007 g_application_register (GApplication *application,
1008 GCancellable *cancellable,
1011 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1013 if (!application->priv->is_registered)
1015 if (~application->priv->flags & G_APPLICATION_NON_UNIQUE)
1017 application->priv->impl =
1018 g_application_impl_register (application, application->priv->id,
1019 application->priv->flags,
1020 &application->priv->remote_actions,
1021 cancellable, error);
1023 if (application->priv->impl == NULL)
1027 application->priv->is_remote = application->priv->remote_actions != NULL;
1028 application->priv->is_registered = TRUE;
1030 g_object_notify (G_OBJECT (application), "is-registered");
1032 if (!application->priv->is_remote)
1034 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1036 if (!application->priv->did_startup)
1037 g_critical ("GApplication subclass '%s' failed to chain up on"
1038 " ::startup (from start of override function)",
1039 G_OBJECT_TYPE_NAME (application));
1046 /* Hold/release {{{1 */
1048 * g_application_hold:
1049 * @application: a #GApplication
1051 * Increases the use count of @application.
1053 * Use this function to indicate that the application has a reason to
1054 * continue to run. For example, g_application_hold() is called by GTK+
1055 * when a toplevel window is on the screen.
1057 * To cancel the hold, call g_application_release().
1060 g_application_hold (GApplication *application)
1062 if (application->priv->inactivity_timeout_id)
1064 g_source_remove (application->priv->inactivity_timeout_id);
1065 application->priv->inactivity_timeout_id = 0;
1068 application->priv->use_count++;
1072 inactivity_timeout_expired (gpointer data)
1074 GApplication *application = G_APPLICATION (data);
1076 application->priv->inactivity_timeout_id = 0;
1083 * g_application_release:
1084 * @application: a #GApplication
1086 * Decrease the use count of @application.
1088 * When the use count reaches zero, the application will stop running.
1090 * Never call this function except to cancel the effect of a previous
1091 * call to g_application_hold().
1094 g_application_release (GApplication *application)
1096 application->priv->use_count--;
1098 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
1099 application->priv->inactivity_timeout_id = g_timeout_add (application->priv->inactivity_timeout,
1100 inactivity_timeout_expired, application);
1103 /* Activate, Open {{{1 */
1105 * g_application_activate:
1106 * @application: a #GApplication
1108 * Activates the application.
1110 * In essence, this results in the #GApplication::activate() signal being
1111 * emitted in the primary instance.
1113 * The application must be registered before calling this function.
1118 g_application_activate (GApplication *application)
1120 g_return_if_fail (G_IS_APPLICATION (application));
1121 g_return_if_fail (application->priv->is_registered);
1123 if (application->priv->is_remote)
1124 g_application_impl_activate (application->priv->impl,
1125 get_platform_data (application));
1128 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1132 * g_application_open:
1133 * @application: a #GApplication
1134 * @files: (array length=n_files): an array of #GFiles to open
1135 * @n_files: the length of the @files array
1136 * @hint: a hint (or ""), but never %NULL
1138 * Opens the given files.
1140 * In essence, this results in the #GApplication::open signal being emitted
1141 * in the primary instance.
1143 * @n_files must be greater than zero.
1145 * @hint is simply passed through to the ::open signal. It is
1146 * intended to be used by applications that have multiple modes for
1147 * opening files (eg: "view" vs "edit", etc). Unless you have a need
1148 * for this functionality, you should use "".
1150 * The application must be registered before calling this function
1151 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1156 g_application_open (GApplication *application,
1161 g_return_if_fail (G_IS_APPLICATION (application));
1162 g_return_if_fail (application->priv->flags &
1163 G_APPLICATION_HANDLES_OPEN);
1164 g_return_if_fail (application->priv->is_registered);
1166 if (application->priv->is_remote)
1167 g_application_impl_open (application->priv->impl,
1168 files, n_files, hint,
1169 get_platform_data (application));
1172 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1173 0, files, n_files, hint);
1178 * g_application_run:
1179 * @application: a #GApplication
1180 * @argc: the argc from main() (or 0 if @argv is %NULL)
1181 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1183 * Runs the application.
1185 * This function is intended to be run from main() and its return value
1186 * is intended to be returned by main(). Although you are expected to pass
1187 * the @argc, @argv parameters from main() to this function, it is possible
1188 * to pass %NULL if @argv is not available or commandline handling is not
1191 * First, the local_command_line() virtual function is invoked.
1192 * This function always runs on the local instance. It gets passed a pointer
1193 * to a %NULL-terminated copy of @argv and is expected to remove the arguments
1194 * that it handled (shifting up remaining arguments). See
1195 * <xref linkend="gapplication-example-cmdline2"/> for an example of
1196 * parsing @argv manually. Alternatively, you may use the #GOptionContext API,
1197 * after setting <literal>argc = g_strv_length (argv);</literal>.
1199 * The last argument to local_command_line() is a pointer to the @status
1200 * variable which can used to set the exit status that is returned from
1201 * g_application_run().
1203 * If local_command_line() returns %TRUE, the command line is expected
1204 * to be completely handled, including possibly registering as the primary
1205 * instance, calling g_application_activate() or g_application_open(), etc.
1207 * If local_command_line() returns %FALSE then the application is registered
1208 * and the #GApplication::command-line signal is emitted in the primary
1209 * instance (which may or may not be this instance). The signal handler
1210 * gets passed a #GApplicationCommandline object that (among other things)
1211 * contains the remaining commandline arguments that have not been handled
1212 * by local_command_line().
1214 * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1215 * flag set then the default implementation of local_command_line()
1216 * always returns %FALSE immediately, resulting in the commandline
1217 * always being handled in the primary instance.
1219 * Otherwise, the default implementation of local_command_line() tries
1220 * to do a couple of things that are probably reasonable for most
1221 * applications. First, g_application_register() is called to attempt
1222 * to register the application. If that works, then the command line
1223 * arguments are inspected. If no commandline arguments are given, then
1224 * g_application_activate() is called. If commandline arguments are
1225 * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1226 * are assumed to be filenames and g_application_open() is called.
1228 * If you need to handle commandline arguments that are not filenames,
1229 * and you don't mind commandline handling to happen in the primary
1230 * instance, you should set %G_APPLICATION_HANDLED_COMMAND_LINE and
1231 * process the commandline arguments in your #GApplication::command-line
1232 * signal handler, either manually or using the #GOptionContext API.
1234 * If you are interested in doing more complicated local handling of the
1235 * commandline then you should implement your own #GApplication subclass
1236 * and override local_command_line(). In this case, you most likely want
1237 * to return %TRUE from your local_command_line() implementation to
1238 * suppress the default handling. See
1239 * <xref linkend="gapplication-example-cmdline2"/> for an example.
1241 * If, after the above is done, the use count of the application is zero
1242 * then the exit status is returned immediately. If the use count is
1243 * non-zero then the mainloop is run until the use count falls to zero,
1244 * at which point 0 is returned.
1246 * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
1247 * use count of zero is delayed for a while (ie: the instance stays
1248 * around to provide its <emphasis>service</emphasis> to others).
1250 * Returns: the exit status
1255 g_application_run (GApplication *application,
1263 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1264 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1266 arguments = g_new (gchar *, argc + 1);
1267 for (i = 0; i < argc; i++)
1268 arguments[i] = g_strdup (argv[i]);
1269 arguments[i] = NULL;
1271 if (g_get_prgname () == NULL && argc > 0)
1275 prgname = g_path_get_basename (argv[0]);
1276 g_set_prgname (prgname);
1280 if (!G_APPLICATION_GET_CLASS (application)
1281 ->local_command_line (application, &arguments, &status))
1283 GError *error = NULL;
1285 if (!g_application_register (application, NULL, &error))
1287 g_printerr ("%s", error->message);
1288 g_error_free (error);
1292 if (application->priv->is_remote)
1294 GVariant *platform_data;
1296 platform_data = get_platform_data (application);
1297 status = g_application_impl_command_line (application->priv->impl,
1298 arguments, platform_data);
1302 GApplicationCommandLine *cmdline;
1305 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1306 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1307 "arguments", v, NULL);
1308 g_signal_emit (application,
1309 g_application_signals[SIGNAL_COMMAND_LINE],
1310 0, cmdline, &status);
1311 g_object_unref (cmdline);
1315 g_strfreev (arguments);
1317 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1318 application->priv->is_registered &&
1319 !application->priv->use_count &&
1320 !application->priv->inactivity_timeout_id)
1322 application->priv->inactivity_timeout_id =
1323 g_timeout_add (10000, inactivity_timeout_expired, application);
1326 while (application->priv->use_count || application->priv->inactivity_timeout_id)
1328 g_main_context_iteration (NULL, TRUE);
1332 if (!application->priv->is_remote)
1334 g_signal_emit (application, g_application_signals[SIGNAL_SHUTDOWN], 0);
1336 if (!application->priv->did_shutdown)
1337 g_critical ("GApplication subclass '%s' failed to chain up on"
1338 " ::shutdown (from end of override function)",
1339 G_OBJECT_TYPE_NAME (application));
1342 if (application->priv->impl)
1343 g_application_impl_flush (application->priv->impl);
1351 g_application_has_action (GActionGroup *action_group,
1352 const gchar *action_name)
1354 GApplication *application = G_APPLICATION (action_group);
1356 g_return_val_if_fail (application->priv->is_registered, FALSE);
1358 if (application->priv->remote_actions != NULL)
1359 return g_hash_table_lookup (application->priv->remote_actions,
1360 action_name) != NULL;
1362 return application->priv->actions &&
1363 g_action_group_has_action (application->priv->actions, action_name);
1367 g_application_list_actions (GActionGroup *action_group)
1369 GApplication *application = G_APPLICATION (action_group);
1371 g_return_val_if_fail (application->priv->is_registered, NULL);
1373 if (application->priv->remote_actions != NULL)
1375 GHashTableIter iter;
1380 n = g_hash_table_size (application->priv->remote_actions);
1381 keys = g_new (gchar *, n + 1);
1383 g_hash_table_iter_init (&iter, application->priv->remote_actions);
1384 while (g_hash_table_iter_next (&iter, &key, NULL))
1385 keys[i++] = g_strdup (key);
1386 g_assert_cmpint (i, ==, n);
1392 else if (application->priv->actions != NULL)
1393 return g_action_group_list_actions (application->priv->actions);
1396 /* empty string array */
1397 return g_new0 (gchar *, 1);
1401 g_application_get_action_enabled (GActionGroup *action_group,
1402 const gchar *action_name)
1404 GApplication *application = G_APPLICATION (action_group);
1406 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1407 application->priv->actions != NULL, FALSE);
1408 g_return_val_if_fail (application->priv->is_registered, FALSE);
1410 if (application->priv->remote_actions)
1412 RemoteActionInfo *info;
1414 info = g_hash_table_lookup (application->priv->remote_actions,
1417 return info && info->enabled;
1420 return g_action_group_get_action_enabled (application->priv->actions,
1424 static const GVariantType *
1425 g_application_get_action_parameter_type (GActionGroup *action_group,
1426 const gchar *action_name)
1428 GApplication *application = G_APPLICATION (action_group);
1430 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1431 application->priv->actions != NULL, NULL);
1432 g_return_val_if_fail (application->priv->is_registered, NULL);
1434 if (application->priv->remote_actions)
1436 RemoteActionInfo *info;
1438 info = g_hash_table_lookup (application->priv->remote_actions,
1442 return info->parameter_type;
1447 return g_action_group_get_action_parameter_type (application->priv->actions,
1451 static const GVariantType *
1452 g_application_get_action_state_type (GActionGroup *action_group,
1453 const gchar *action_name)
1455 GApplication *application = G_APPLICATION (action_group);
1457 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1458 application->priv->actions != NULL, NULL);
1459 g_return_val_if_fail (application->priv->is_registered, NULL);
1461 if (application->priv->remote_actions)
1463 RemoteActionInfo *info;
1465 info = g_hash_table_lookup (application->priv->remote_actions,
1468 if (info && info->state)
1469 return g_variant_get_type (info->state);
1474 return g_action_group_get_action_state_type (application->priv->actions,
1479 g_application_get_action_state (GActionGroup *action_group,
1480 const gchar *action_name)
1482 GApplication *application = G_APPLICATION (action_group);
1484 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1485 application->priv->actions != NULL, NULL);
1486 g_return_val_if_fail (application->priv->is_registered, NULL);
1488 if (application->priv->remote_actions)
1490 RemoteActionInfo *info;
1492 info = g_hash_table_lookup (application->priv->remote_actions,
1495 if (info && info->state)
1496 return g_variant_ref (info->state);
1501 return g_action_group_get_action_state (application->priv->actions,
1506 g_application_change_action_state (GActionGroup *action_group,
1507 const gchar *action_name,
1510 GApplication *application = G_APPLICATION (action_group);
1512 g_return_if_fail (application->priv->is_remote ||
1513 application->priv->actions != NULL);
1514 g_return_if_fail (application->priv->is_registered);
1516 if (application->priv->is_remote)
1517 g_application_impl_change_action_state (application->priv->impl,
1519 get_platform_data (application));
1522 g_action_group_change_action_state (application->priv->actions,
1523 action_name, value);
1527 g_application_activate_action (GActionGroup *action_group,
1528 const gchar *action_name,
1529 GVariant *parameter)
1531 GApplication *application = G_APPLICATION (action_group);
1533 g_return_if_fail (application->priv->is_remote ||
1534 application->priv->actions != NULL);
1535 g_return_if_fail (application->priv->is_registered);
1537 if (application->priv->is_remote)
1538 g_application_impl_activate_action (application->priv->impl,
1539 action_name, parameter,
1540 get_platform_data (application));
1543 g_action_group_activate_action (application->priv->actions,
1544 action_name, parameter);
1548 g_application_action_group_iface_init (GActionGroupInterface *iface)
1550 iface->has_action = g_application_has_action;
1551 iface->list_actions = g_application_list_actions;
1553 iface->get_action_enabled = g_application_get_action_enabled;
1554 iface->get_action_parameter_type = g_application_get_action_parameter_type;
1555 iface->get_action_state_type = g_application_get_action_state_type;
1556 iface->get_action_state = g_application_get_action_state;
1557 iface->change_action_state = g_application_change_action_state;
1558 iface->activate_action = g_application_activate_action;
1562 /* vim:set foldmethod=marker: */