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"
31 #include "gioenumtypes.h"
32 #include "gio-marshal.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;
154 guint inactivity_timeout_id;
155 guint inactivity_timeout;
158 guint is_registered : 1;
161 GHashTable *remote_actions; /* string -> RemoteActionInfo */
162 GApplicationImpl *impl;
172 PROP_INACTIVITY_TIMEOUT,
186 static guint g_application_signals[NR_SIGNALS];
188 static void g_application_action_group_iface_init (GActionGroupInterface *);
189 G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
190 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP,
191 g_application_action_group_iface_init))
193 /* vfunc defaults {{{1 */
195 g_application_real_before_emit (GApplication *application,
196 GVariant *platform_data)
201 g_application_real_after_emit (GApplication *application,
202 GVariant *platform_data)
207 g_application_real_startup (GApplication *application)
212 g_application_real_activate (GApplication *application)
214 if (!g_signal_has_handler_pending (application,
215 g_application_signals[SIGNAL_ACTIVATE],
217 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
219 static gboolean warned;
224 g_warning ("Your application does not implement "
225 "g_application_activate() and has no handlers connected "
226 "to the 'activate' signal. It should do one of these.");
232 g_application_real_open (GApplication *application,
237 if (!g_signal_has_handler_pending (application,
238 g_application_signals[SIGNAL_OPEN],
240 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
242 static gboolean warned;
247 g_warning ("Your application claims to support opening files "
248 "but does not implement g_application_open() and has no "
249 "handlers connected to the 'open' signal.");
255 g_application_real_command_line (GApplication *application,
256 GApplicationCommandLine *cmdline)
258 if (!g_signal_has_handler_pending (application,
259 g_application_signals[SIGNAL_COMMAND_LINE],
261 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
263 static gboolean warned;
268 g_warning ("Your application claims to support custom command line "
269 "handling but does not implement g_application_command_line() "
270 "and has no handlers connected to the 'command-line' signal.");
279 g_application_real_local_command_line (GApplication *application,
283 if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
288 GError *error = NULL;
291 if (!g_application_register (application, NULL, &error))
293 g_critical ("%s", error->message);
294 g_error_free (error);
299 n_args = g_strv_length (*arguments);
301 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
303 if ((*exit_status = n_args > 1))
305 g_printerr ("GApplication service mode takes no arguments.\n");
306 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
314 g_application_activate (application);
320 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
322 g_critical ("This application can not open files.");
331 n_files = n_args - 1;
332 files = g_new (GFile *, n_files);
334 for (i = 0; i < n_files; i++)
335 files[i] = g_file_new_for_commandline_arg ((*arguments)[i + 1]);
337 g_application_open (application, files, n_files, "");
339 for (i = 0; i < n_files; i++)
340 g_object_unref (files[i]);
352 g_application_real_add_platform_data (GApplication *application,
353 GVariantBuilder *builder)
358 g_application_real_quit_mainloop (GApplication *application)
360 if (application->priv->mainloop != NULL)
361 g_main_loop_quit (application->priv->mainloop);
365 g_application_real_run_mainloop (GApplication *application)
367 if (application->priv->mainloop == NULL)
368 application->priv->mainloop = g_main_loop_new (NULL, FALSE);
370 g_main_loop_run (application->priv->mainloop);
373 /* GObject implementation stuff {{{1 */
375 g_application_set_property (GObject *object,
380 GApplication *application = G_APPLICATION (object);
384 case PROP_APPLICATION_ID:
385 g_application_set_application_id (application,
386 g_value_get_string (value));
390 g_application_set_flags (application, g_value_get_flags (value));
393 case PROP_INACTIVITY_TIMEOUT:
394 g_application_set_inactivity_timeout (application,
395 g_value_get_uint (value));
398 case PROP_ACTION_GROUP:
399 g_application_set_action_group (application,
400 g_value_get_object (value));
404 g_assert_not_reached ();
409 * g_application_set_action_group:
410 * @application: a #GApplication
411 * @action_group: (allow-none): a #GActionGroup, or %NULL
413 * Sets or unsets the group of actions associated with the application.
415 * These actions are the actions that can be remotely invoked.
417 * It is an error to call this function after the application has been
423 g_application_set_action_group (GApplication *application,
424 GActionGroup *action_group)
426 g_return_if_fail (G_IS_APPLICATION (application));
427 g_return_if_fail (!application->priv->is_registered);
429 if (application->priv->actions != NULL)
430 g_object_unref (application->priv->actions);
432 application->priv->actions = action_group;
434 if (application->priv->actions != NULL)
435 g_object_ref (application->priv->actions);
439 g_application_get_property (GObject *object,
444 GApplication *application = G_APPLICATION (object);
448 case PROP_APPLICATION_ID:
449 g_value_set_string (value,
450 g_application_get_application_id (application));
454 g_value_set_flags (value,
455 g_application_get_flags (application));
458 case PROP_IS_REGISTERED:
459 g_value_set_boolean (value,
460 g_application_get_is_registered (application));
464 g_value_set_boolean (value,
465 g_application_get_is_remote (application));
468 case PROP_INACTIVITY_TIMEOUT:
469 g_value_set_uint (value,
470 g_application_get_inactivity_timeout (application));
474 g_assert_not_reached ();
479 g_application_constructed (GObject *object)
481 GApplication *application = G_APPLICATION (object);
483 g_assert (application->priv->id != NULL);
487 g_application_finalize (GObject *object)
489 GApplication *application = G_APPLICATION (object);
491 if (application->priv->impl)
492 g_application_impl_destroy (application->priv->impl);
493 g_free (application->priv->id);
495 if (application->priv->mainloop)
496 g_main_loop_unref (application->priv->mainloop);
498 G_OBJECT_CLASS (g_application_parent_class)
503 g_application_init (GApplication *application)
505 application->priv = G_TYPE_INSTANCE_GET_PRIVATE (application,
507 GApplicationPrivate);
511 g_application_class_init (GApplicationClass *class)
513 GObjectClass *object_class = G_OBJECT_CLASS (class);
515 object_class->constructed = g_application_constructed;
516 object_class->finalize = g_application_finalize;
517 object_class->get_property = g_application_get_property;
518 object_class->set_property = g_application_set_property;
520 class->before_emit = g_application_real_before_emit;
521 class->after_emit = g_application_real_after_emit;
522 class->startup = g_application_real_startup;
523 class->activate = g_application_real_activate;
524 class->open = g_application_real_open;
525 class->command_line = g_application_real_command_line;
526 class->local_command_line = g_application_real_local_command_line;
527 class->add_platform_data = g_application_real_add_platform_data;
528 class->quit_mainloop = g_application_real_quit_mainloop;
529 class->run_mainloop = g_application_real_run_mainloop;
531 g_object_class_install_property (object_class, PROP_APPLICATION_ID,
532 g_param_spec_string ("application-id",
533 P_("Application identifier"),
534 P_("The unique identifier for the application"),
535 NULL, G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
536 G_PARAM_STATIC_STRINGS));
538 g_object_class_install_property (object_class, PROP_FLAGS,
539 g_param_spec_flags ("flags",
540 P_("Application flags"),
541 P_("Flags specifying the behaviour of the application"),
542 G_TYPE_APPLICATION_FLAGS, G_APPLICATION_FLAGS_NONE,
543 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
545 g_object_class_install_property (object_class, PROP_IS_REGISTERED,
546 g_param_spec_boolean ("is-registered",
548 P_("If g_application_register() has been called"),
549 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
551 g_object_class_install_property (object_class, PROP_IS_REMOTE,
552 g_param_spec_boolean ("is-remote",
554 P_("If this application instance is remote"),
555 FALSE, G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
557 g_object_class_install_property (object_class, PROP_INACTIVITY_TIMEOUT,
558 g_param_spec_uint ("inactivity-timeout",
559 P_("Inactivity timeout"),
560 P_("Iime (ms) to stay alive after becoming idle"),
562 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
564 g_object_class_install_property (object_class, PROP_ACTION_GROUP,
565 g_param_spec_object ("action-group",
567 P_("The group of actions that the application exports"),
569 G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
572 * GApplication::startup:
573 * @application: the application
575 * The ::startup signal is emitted on the primary instance immediately
576 * after registration. See g_application_register().
578 g_application_signals[SIGNAL_STARTUP] =
579 g_signal_new ("startup", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
580 G_STRUCT_OFFSET (GApplicationClass, startup),
581 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
584 * GApplication::activate:
585 * @application: the application
587 * The ::activate signal is emitted on the primary instance when an
588 * activation occurs. See g_application_activate().
590 g_application_signals[SIGNAL_ACTIVATE] =
591 g_signal_new ("activate", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
592 G_STRUCT_OFFSET (GApplicationClass, activate),
593 NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
597 * GApplication::open:
598 * @application: the application
599 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
600 * @n_files: the length of @files
601 * @hint: a hint provided by the calling instance
603 * The ::open signal is emitted on the primary instance when there are
604 * files to open. See g_application_open() for more information.
606 g_application_signals[SIGNAL_OPEN] =
607 g_signal_new ("open", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
608 G_STRUCT_OFFSET (GApplicationClass, open),
609 NULL, NULL, _gio_marshal_VOID__POINTER_INT_STRING,
610 G_TYPE_NONE, 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
613 * GApplication::command-line:
614 * @application: the application
615 * @command_line: a #GApplicationCommandLine representing the
618 * The ::command-line signal is emitted on the primary instance when
619 * a commandline is not handled locally. See g_application_run() and
620 * the #GApplicationCommandline documentation for more information.
622 * Returns: An integer that is set as the exit status for the calling
623 * process. See g_application_command_line_set_exit_status().
625 g_application_signals[SIGNAL_COMMAND_LINE] =
626 g_signal_new ("command-line", G_TYPE_APPLICATION, G_SIGNAL_RUN_LAST,
627 G_STRUCT_OFFSET (GApplicationClass, command_line),
628 g_signal_accumulator_first_wins, NULL,
629 _gio_marshal_INT__OBJECT,
630 G_TYPE_INT, 1, G_TYPE_APPLICATION_COMMAND_LINE);
632 g_type_class_add_private (class, sizeof (GApplicationPrivate));
636 get_platform_data (GApplication *application)
638 GVariantBuilder *builder;
641 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
644 gchar *cwd = g_get_current_dir ();
645 g_variant_builder_add (builder, "{sv}", "cwd",
646 g_variant_new_bytestring (cwd));
650 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
655 envp = g_get_environ ();
656 array = g_variant_new_bytestring_array ((const gchar **) envp, -1);
659 g_variant_builder_add (builder, "{sv}", "environ", array);
662 G_APPLICATION_GET_CLASS (application)->
663 add_platform_data (application, builder);
665 result = g_variant_builder_end (builder);
666 g_variant_builder_unref (builder);
671 /* Application ID validity {{{1 */
674 * g_application_id_is_valid:
675 * @application_id: a potential application identifier
676 * @returns: %TRUE if @application_id is valid
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>
694 g_application_id_is_valid (const gchar *application_id)
700 len = strlen (application_id);
705 if (!g_ascii_isalpha (application_id[0]))
708 if (application_id[len-1] == '.')
714 for (; *application_id; application_id++)
716 if (g_ascii_isalnum (*application_id) ||
717 (*application_id == '-') ||
718 (*application_id == '_'))
722 else if (allow_dot && *application_id == '.')
737 /* Public Constructor {{{1 */
740 * @application_id: the application id
741 * @flags: the application flags
742 * @returns: a new #GApplication instance
744 * Creates a new #GApplication instance.
746 * This function calls g_type_init() for you.
748 * The application id must be valid. See g_application_id_is_valid().
751 g_application_new (const gchar *application_id,
752 GApplicationFlags flags)
754 g_return_val_if_fail (g_application_id_is_valid (application_id), NULL);
758 return g_object_new (G_TYPE_APPLICATION,
759 "application-id", application_id,
764 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
766 * g_application_get_application_id:
767 * @application: a #GApplication
768 * @returns: the identifier for @application, owned by @application
770 * Gets the unique identifier for @application.
775 g_application_get_application_id (GApplication *application)
777 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
779 return application->priv->id;
783 * g_application_set_application_id:
784 * @application: a #GApplication
785 * @application_id: the identifier for @application
787 * Sets the unique identifier for @application.
789 * The application id can only be modified if @application has not yet
792 * The application id must be valid. See g_application_id_is_valid().
797 g_application_set_application_id (GApplication *application,
798 const gchar *application_id)
800 g_return_if_fail (G_IS_APPLICATION (application));
802 if (g_strcmp0 (application->priv->id, application_id) != 0)
804 g_return_if_fail (g_application_id_is_valid (application_id));
805 g_return_if_fail (!application->priv->is_registered);
807 g_free (application->priv->id);
808 application->priv->id = g_strdup (application_id);
810 g_object_notify (G_OBJECT (application), "application-id");
815 * g_application_get_flags:
816 * @application: a #GApplication
817 * @returns: the flags for @application
819 * Gets the flags for @application.
821 * See #GApplicationFlags.
826 g_application_get_flags (GApplication *application)
828 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
830 return application->priv->flags;
834 * g_application_set_flags:
835 * @application: a #GApplication
836 * @flags: the flags for @application
838 * Sets the flags for @application.
840 * The flags can only be modified if @application has not yet been
843 * See #GApplicationFlags.
848 g_application_set_flags (GApplication *application,
849 GApplicationFlags flags)
851 g_return_if_fail (G_IS_APPLICATION (application));
853 if (application->priv->flags != flags)
855 g_return_if_fail (!application->priv->is_registered);
857 application->priv->flags = flags;
859 g_object_notify (G_OBJECT (application), "flags");
864 * g_application_get_inactivity_timeout:
865 * @application: a #GApplication
867 * Gets the current inactivity timeout for the application.
869 * This is the amount of time (in milliseconds) after the last call to
870 * g_application_release() before the application stops running.
872 * Returns: the timeout, in milliseconds
877 g_application_get_inactivity_timeout (GApplication *application)
879 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
881 return application->priv->inactivity_timeout;
885 * g_application_set_inactivity_timeout:
886 * @application: a #GApplication
887 * @inactivity_timeout: the timeout, in milliseconds
889 * Sets the current inactivity timeout for the application.
891 * This is the amount of time (in milliseconds) after the last call to
892 * g_application_release() before the application stops running.
894 * This call has no side effects of its own. The value set here is only
895 * used for next time g_application_release() drops the use count to
896 * zero. Any timeouts currently in progress are not impacted.
898 * Returns: the timeout, in milliseconds
903 g_application_set_inactivity_timeout (GApplication *application,
904 guint inactivity_timeout)
906 g_return_if_fail (G_IS_APPLICATION (application));
908 if (application->priv->inactivity_timeout != inactivity_timeout)
910 application->priv->inactivity_timeout = inactivity_timeout;
912 g_object_notify (G_OBJECT (application), "inactivity-timeout");
915 /* Read-only property getters (is registered, is remote) {{{1 */
917 * g_application_get_is_registered:
918 * @application: a #GApplication
919 * @returns: %TRUE if @application is registered
921 * Checks if @application is registered.
923 * An application is registered if g_application_register() has been
924 * successfully called.
929 g_application_get_is_registered (GApplication *application)
931 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
933 return application->priv->is_registered;
937 * g_application_get_is_remote:
938 * @application: a #GApplication
939 * @returns: %TRUE if @application is remote
941 * Checks if @application is remote.
943 * If @application is remote then it means that another instance of
944 * application already exists (the 'primary' instance). Calls to
945 * perform actions on @application will result in the actions being
946 * performed by the primary instance.
948 * The value of this property cannot be accessed before
949 * g_application_register() has been called. See
950 * g_application_get_is_registered().
955 g_application_get_is_remote (GApplication *application)
957 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
958 g_return_val_if_fail (application->priv->is_registered, FALSE);
960 return application->priv->is_remote;
965 * g_application_register:
966 * @application: a #GApplication
967 * @cancellable: a #GCancellable, or %NULL
968 * @error: a pointer to a NULL #GError, or %NULL
969 * @returns: %TRUE if registration succeeded
971 * Attempts registration of the application.
973 * This is the point at which the application discovers if it is the
974 * primary instance or merely acting as a remote for an already-existing
975 * primary instance. This is implemented by attempting to acquire the
976 * application identifier as a unique bus name on the session bus using
979 * Due to the internal architecture of GDBus, method calls can be
980 * dispatched at any time (even if a main loop is not running). For
981 * this reason, you must ensure that any object paths that you wish to
982 * register are registered before calling this function.
984 * If the application has already been registered then %TRUE is
985 * returned with no work performed.
987 * The #GApplication::startup signal is emitted if registration succeeds
988 * and @application is the primary instance.
990 * In the event of an error (such as @cancellable being cancelled, or a
991 * failure to connect to the session bus), %FALSE is returned and @error
992 * is set appropriately.
994 * Note: the return value of this function is not an indicator that this
995 * instance is or is not the primary instance of the application. See
996 * g_application_get_is_remote() for that.
1001 g_application_register (GApplication *application,
1002 GCancellable *cancellable,
1005 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
1007 if (!application->priv->is_registered)
1009 if (~application->priv->flags & G_APPLICATION_NON_UNIQUE)
1011 application->priv->impl =
1012 g_application_impl_register (application, application->priv->id,
1013 application->priv->flags,
1014 &application->priv->remote_actions,
1015 cancellable, error);
1017 if (application->priv->impl == NULL)
1021 application->priv->is_remote = application->priv->remote_actions != NULL;
1022 application->priv->is_registered = TRUE;
1024 g_object_notify (G_OBJECT (application), "is-registered");
1026 if (!application->priv->is_remote)
1027 g_signal_emit (application, g_application_signals[SIGNAL_STARTUP], 0);
1033 /* Hold/release {{{1 */
1035 * g_application_hold:
1036 * @application: a #GApplication
1038 * Increases the use count of @application.
1040 * Use this function to indicate that the application has a reason to
1041 * continue to run. For example, g_application_hold() is called by GTK+
1042 * when a toplevel window is on the screen.
1044 * To cancel the hold, call g_application_release().
1047 g_application_hold (GApplication *application)
1049 if (application->priv->inactivity_timeout_id)
1051 g_source_remove (application->priv->inactivity_timeout_id);
1052 application->priv->inactivity_timeout_id = 0;
1055 application->priv->use_count++;
1059 inactivity_timeout_expired (gpointer data)
1061 GApplication *application = G_APPLICATION (data);
1063 G_APPLICATION_GET_CLASS (application)
1064 ->quit_mainloop (application);
1071 * g_application_release:
1072 * @application: a #GApplication
1074 * Decrease the use count of @application.
1076 * When the use count reaches zero, the application will stop running.
1078 * Never call this function except to cancel the effect of a previous
1079 * call to g_application_hold().
1082 g_application_release (GApplication *application)
1084 application->priv->use_count--;
1086 if (application->priv->use_count == 0)
1088 if (application->priv->inactivity_timeout)
1089 application->priv->inactivity_timeout_id =
1090 g_timeout_add (application->priv->inactivity_timeout,
1091 inactivity_timeout_expired, application);
1094 G_APPLICATION_GET_CLASS (application)
1095 ->quit_mainloop (application);
1099 /* Activate, Open {{{1 */
1101 * g_application_activate:
1102 * @application: a #GApplication
1104 * Activates the application.
1106 * In essence, this results in the #GApplication::activate() signal being
1107 * emitted in the primary instance.
1109 * The application must be registered before calling this function.
1114 g_application_activate (GApplication *application)
1116 g_return_if_fail (G_IS_APPLICATION (application));
1117 g_return_if_fail (application->priv->is_registered);
1119 if (application->priv->is_remote)
1120 g_application_impl_activate (application->priv->impl,
1121 get_platform_data (application));
1124 g_signal_emit (application, g_application_signals[SIGNAL_ACTIVATE], 0);
1128 * g_application_open:
1129 * @application: a #GApplication
1130 * @files: (array length=n_files): an array of #GFiles to open
1131 * @n_files: the length of the @files array
1132 * @hint: a hint (or ""), but never %NULL
1134 * Opens the given files.
1136 * In essence, this results in the #GApplication::open signal being emitted
1137 * in the primary instance.
1139 * @n_files must be greater than zero.
1141 * @hint is simply passed through to the ::open signal. It is
1142 * intended to be used by applications that have multiple modes for
1143 * opening files (eg: "view" vs "edit", etc). Unless you have a need
1144 * for this functionality, you should use "".
1146 * The application must be registered before calling this function
1147 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1152 g_application_open (GApplication *application,
1157 g_return_if_fail (G_IS_APPLICATION (application));
1158 g_return_if_fail (application->priv->flags &
1159 G_APPLICATION_HANDLES_OPEN);
1160 g_return_if_fail (application->priv->is_registered);
1162 if (application->priv->is_remote)
1163 g_application_impl_open (application->priv->impl,
1164 files, n_files, hint,
1165 get_platform_data (application));
1168 g_signal_emit (application, g_application_signals[SIGNAL_OPEN],
1169 0, files, n_files, hint);
1174 * g_application_run:
1175 * @application: a #GApplication
1176 * @argc: the argc from main() (or 0 if @argv is %NULL)
1177 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1178 * @returns: the exit status
1180 * Runs the application.
1182 * This function is intended to be run from main() and its return value
1183 * is intended to be returned by main(). Although you are expected to pass
1184 * the @argc, @argv parameters from main() to this function, it is possible
1185 * to pass %NULL if @argv is not available or commandline handling is not
1188 * First, the local_command_line() virtual function is invoked.
1189 * This function always runs on the local instance. It gets passed a pointer
1190 * to a %NULL-terminated copy of @argv and is expected to remove the arguments
1191 * that it handled (shifting up remaining arguments). See
1192 * <xref linkend="gapplication-example-cmdline2"/> for an example of
1193 * parsing @argv manually. Alternatively, you may use the #GOptionContext API,
1194 * after setting <literal>argc = g_strv_length (argv);</literal>.
1196 * The last argument to local_command_line() is a pointer to the @status
1197 * variable which can used to set the exit status that is returned from
1198 * g_application_run().
1200 * If local_command_line() returns %TRUE, the command line is expected
1201 * to be completely handled, including possibly registering as the primary
1202 * instance, calling g_application_activate() or g_application_open(), etc.
1204 * If local_command_line() returns %FALSE then the application is registered
1205 * and the #GApplication::command-line signal is emitted in the primary
1206 * instance (which may or may not be this instance). The signal handler
1207 * gets passed a #GApplicationCommandline object that (among other things)
1208 * contains the remaining commandline arguments that have not been handled
1209 * by local_command_line().
1211 * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1212 * flag set then the default implementation of local_command_line()
1213 * always returns %FALSE immediately, resulting in the commandline
1214 * always being handled in the primary instance.
1216 * Otherwise, the default implementation of local_command_line() tries
1217 * to do a couple of things that are probably reasonable for most
1218 * applications. First, g_application_register() is called to attempt
1219 * to register the application. If that works, then the command line
1220 * arguments are inspected. If no commandline arguments are given, then
1221 * g_application_activate() is called. If commandline arguments are
1222 * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1223 * are assumed to be filenames and g_application_open() is called.
1225 * If you need to handle commandline arguments that are not filenames,
1226 * and you don't mind commandline handling to happen in the primary
1227 * instance, you should set %G_APPLICATION_HANDLED_COMMAND_LINE and
1228 * process the commandline arguments in your #GApplication::command-line
1229 * signal handler, either manually or using the #GOptionContext API.
1231 * If you are interested in doing more complicated local handling of the
1232 * commandline then you should implement your own #GApplication subclass
1233 * and override local_command_line(). In this case, you most likely want
1234 * to return %TRUE from your local_command_line() implementation to
1235 * suppress the default handling. See
1236 * <xref linkend="gapplication-example-cmdline2"/> for an example.
1238 * If, after the above is done, the use count of the application is zero
1239 * then the exit status is returned immediately. If the use count is
1240 * non-zero then the mainloop is run until the use count falls to zero,
1241 * at which point 0 is returned.
1243 * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
1244 * use count of zero is delayed for a while (ie: the instance stays
1245 * around to provide its <emphasis>service</emphasis> to others).
1250 g_application_run (GApplication *application,
1258 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
1259 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
1261 arguments = g_new (gchar *, argc + 1);
1262 for (i = 0; i < argc; i++)
1263 arguments[i] = g_strdup (argv[i]);
1264 arguments[i] = NULL;
1266 if (g_get_prgname () == NULL && argc > 0)
1270 prgname = g_path_get_basename (argv[0]);
1271 g_set_prgname (prgname);
1275 if (!G_APPLICATION_GET_CLASS (application)
1276 ->local_command_line (application, &arguments, &status))
1278 GError *error = NULL;
1280 if (!g_application_register (application, NULL, &error))
1282 g_printerr ("%s", error->message);
1283 g_error_free (error);
1287 if (application->priv->is_remote)
1289 GVariant *platform_data;
1291 platform_data = get_platform_data (application);
1292 status = g_application_impl_command_line (application->priv->impl,
1293 arguments, platform_data);
1297 GApplicationCommandLine *cmdline;
1300 v = g_variant_new_bytestring_array ((const gchar **) arguments, -1);
1301 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1302 "arguments", v, NULL);
1303 g_signal_emit (application,
1304 g_application_signals[SIGNAL_COMMAND_LINE],
1305 0, cmdline, &status);
1306 g_object_unref (cmdline);
1310 g_strfreev (arguments);
1312 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
1313 application->priv->is_registered &&
1314 !application->priv->use_count &&
1315 !application->priv->inactivity_timeout_id)
1317 application->priv->inactivity_timeout_id =
1318 g_timeout_add (10000, inactivity_timeout_expired, application);
1321 if (application->priv->use_count ||
1322 application->priv->inactivity_timeout_id)
1324 G_APPLICATION_GET_CLASS (application)
1325 ->run_mainloop (application);
1329 if (application->priv->impl)
1330 g_application_impl_flush (application->priv->impl);
1336 g_application_has_action (GActionGroup *action_group,
1337 const gchar *action_name)
1339 GApplication *application = G_APPLICATION (action_group);
1341 g_return_val_if_fail (application->priv->is_registered, FALSE);
1343 if (application->priv->remote_actions != NULL)
1344 return g_hash_table_lookup (application->priv->remote_actions,
1345 action_name) != NULL;
1347 return application->priv->actions &&
1348 g_action_group_has_action (application->priv->actions, action_name);
1352 g_application_list_actions (GActionGroup *action_group)
1354 GApplication *application = G_APPLICATION (action_group);
1356 g_return_val_if_fail (application->priv->is_registered, NULL);
1358 if (application->priv->remote_actions != NULL)
1360 GHashTableIter iter;
1365 n = g_hash_table_size (application->priv->remote_actions);
1366 keys = g_new (gchar *, n + 1);
1368 g_hash_table_iter_init (&iter, application->priv->remote_actions);
1369 while (g_hash_table_iter_next (&iter, &key, NULL))
1370 keys[i++] = g_strdup (key);
1371 g_assert_cmpint (i, ==, n);
1377 else if (application->priv->actions != NULL)
1378 return g_action_group_list_actions (application->priv->actions);
1381 /* empty string array */
1382 return g_new0 (gchar *, 1);
1386 g_application_get_action_enabled (GActionGroup *action_group,
1387 const gchar *action_name)
1389 GApplication *application = G_APPLICATION (action_group);
1391 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1392 application->priv->actions != NULL, FALSE);
1393 g_return_val_if_fail (application->priv->is_registered, FALSE);
1395 if (application->priv->remote_actions)
1397 RemoteActionInfo *info;
1399 info = g_hash_table_lookup (application->priv->remote_actions,
1402 return info && info->enabled;
1405 return g_action_group_get_action_enabled (application->priv->actions,
1409 static const GVariantType *
1410 g_application_get_action_parameter_type (GActionGroup *action_group,
1411 const gchar *action_name)
1413 GApplication *application = G_APPLICATION (action_group);
1415 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1416 application->priv->actions != NULL, NULL);
1417 g_return_val_if_fail (application->priv->is_registered, NULL);
1419 if (application->priv->remote_actions)
1421 RemoteActionInfo *info;
1423 info = g_hash_table_lookup (application->priv->remote_actions,
1427 return info->parameter_type;
1432 return g_action_group_get_action_parameter_type (application->priv->actions,
1436 static const GVariantType *
1437 g_application_get_action_state_type (GActionGroup *action_group,
1438 const gchar *action_name)
1440 GApplication *application = G_APPLICATION (action_group);
1442 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1443 application->priv->actions != NULL, NULL);
1444 g_return_val_if_fail (application->priv->is_registered, NULL);
1446 if (application->priv->remote_actions)
1448 RemoteActionInfo *info;
1450 info = g_hash_table_lookup (application->priv->remote_actions,
1453 if (info && info->state)
1454 return g_variant_get_type (info->state);
1459 return g_action_group_get_action_state_type (application->priv->actions,
1464 g_application_get_action_state (GActionGroup *action_group,
1465 const gchar *action_name)
1467 GApplication *application = G_APPLICATION (action_group);
1469 g_return_val_if_fail (application->priv->remote_actions != NULL ||
1470 application->priv->actions != NULL, NULL);
1471 g_return_val_if_fail (application->priv->is_registered, NULL);
1473 if (application->priv->remote_actions)
1475 RemoteActionInfo *info;
1477 info = g_hash_table_lookup (application->priv->remote_actions,
1480 if (info && info->state)
1481 return g_variant_ref (info->state);
1486 return g_action_group_get_action_state (application->priv->actions,
1491 g_application_change_action_state (GActionGroup *action_group,
1492 const gchar *action_name,
1495 GApplication *application = G_APPLICATION (action_group);
1497 g_return_if_fail (application->priv->is_remote ||
1498 application->priv->actions != NULL);
1499 g_return_if_fail (application->priv->is_registered);
1501 if (application->priv->is_remote)
1502 g_application_impl_change_action_state (application->priv->impl,
1504 get_platform_data (application));
1507 g_action_group_change_action_state (application->priv->actions,
1508 action_name, value);
1512 g_application_activate_action (GActionGroup *action_group,
1513 const gchar *action_name,
1514 GVariant *parameter)
1516 GApplication *application = G_APPLICATION (action_group);
1518 g_return_if_fail (application->priv->is_remote ||
1519 application->priv->actions != NULL);
1520 g_return_if_fail (application->priv->is_registered);
1522 if (application->priv->is_remote)
1523 g_application_impl_activate_action (application->priv->impl,
1524 action_name, parameter,
1525 get_platform_data (application));
1528 g_action_group_activate_action (application->priv->actions,
1529 action_name, parameter);
1533 g_application_action_group_iface_init (GActionGroupInterface *iface)
1535 iface->has_action = g_application_has_action;
1536 iface->list_actions = g_application_list_actions;
1538 iface->get_action_enabled = g_application_get_action_enabled;
1539 iface->get_action_parameter_type = g_application_get_action_parameter_type;
1540 iface->get_action_state_type = g_application_get_action_state_type;
1541 iface->get_action_state = g_application_get_action_state;
1542 iface->change_action_state = g_application_change_action_state;
1543 iface->activate_action = g_application_activate_action;
1547 /* vim:set foldmethod=marker: */