1/*
2 * Copyright © 2010 Codethink Limited
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
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.
13 *
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
16 *
17 * Authors: Ryan Lortie <desrt@desrt.ca>
18 */
19
20/* Prologue {{{1 */
21#include "config.h"
22
23#include "gapplication.h"
24
25#include "gapplicationcommandline.h"
26#include "gsimpleactiongroup.h"
27#include "gremoteactiongroup.h"
28#include "gapplicationimpl.h"
29#include "gactiongroup.h"
30#include "gactionmap.h"
31#include "gsettings.h"
32#include "gnotification-private.h"
33#include "gnotificationbackend.h"
34#include "gdbusutils.h"
35
36#include "gioenumtypes.h"
37#include "gioenums.h"
38#include "gfile.h"
39
40#include "glibintl.h"
41#include "gmarshal-internal.h"
42
43#include <string.h>
44
45/**
46 * SECTION:gapplication
47 * @title: GApplication
48 * @short_description: Core application class
49 * @include: gio/gio.h
50 *
51 * A #GApplication is the foundation of an application. It wraps some
52 * low-level platform-specific services and is intended to act as the
53 * foundation for higher-level application classes such as
54 * #GtkApplication or #MxApplication. In general, you should not use
55 * this class outside of a higher level framework.
56 *
57 * GApplication provides convenient life cycle management by maintaining
58 * a "use count" for the primary application instance. The use count can
59 * be changed using g_application_hold() and g_application_release(). If
60 * it drops to zero, the application exits. Higher-level classes such as
61 * #GtkApplication employ the use count to ensure that the application
62 * stays alive as long as it has any opened windows.
63 *
64 * Another feature that GApplication (optionally) provides is process
65 * uniqueness. Applications can make use of this functionality by
66 * providing a unique application ID. If given, only one application
67 * with this ID can be running at a time per session. The session
68 * concept is platform-dependent, but corresponds roughly to a graphical
69 * desktop login. When your application is launched again, its
70 * arguments are passed through platform communication to the already
71 * running program. The already running instance of the program is
72 * called the "primary instance"; for non-unique applications this is
73 * always the current instance. On Linux, the D-Bus session bus
74 * is used for communication.
75 *
76 * The use of #GApplication differs from some other commonly-used
77 * uniqueness libraries (such as libunique) in important ways. The
78 * application is not expected to manually register itself and check
79 * if it is the primary instance. Instead, the main() function of a
80 * #GApplication should do very little more than instantiating the
81 * application instance, possibly connecting signal handlers, then
82 * calling g_application_run(). All checks for uniqueness are done
83 * internally. If the application is the primary instance then the
84 * startup signal is emitted and the mainloop runs. If the application
85 * is not the primary instance then a signal is sent to the primary
86 * instance and g_application_run() promptly returns. See the code
87 * examples below.
88 *
89 * If used, the expected form of an application identifier is the same as
90 * that of of a
91 * [D-Bus well-known bus name](https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus).
92 * Examples include: `com.example.MyApp`, `org.example.internal_apps.Calculator`,
93 * `org._7_zip.Archiver`.
94 * For details on valid application identifiers, see g_application_id_is_valid().
95 *
96 * On Linux, the application identifier is claimed as a well-known bus name
97 * on the user's session bus. This means that the uniqueness of your
98 * application is scoped to the current session. It also means that your
99 * application may provide additional services (through registration of other
100 * object paths) at that bus name. The registration of these object paths
101 * should be done with the shared GDBus session bus. Note that due to the
102 * internal architecture of GDBus, method calls can be dispatched at any time
103 * (even if a main loop is not running). For this reason, you must ensure that
104 * any object paths that you wish to register are registered before #GApplication
105 * attempts to acquire the bus name of your application (which happens in
106 * g_application_register()). Unfortunately, this means that you cannot use
107 * g_application_get_is_remote() to decide if you want to register object paths.
108 *
109 * GApplication also implements the #GActionGroup and #GActionMap
110 * interfaces and lets you easily export actions by adding them with
111 * g_action_map_add_action(). When invoking an action by calling
112 * g_action_group_activate_action() on the application, it is always
113 * invoked in the primary instance. The actions are also exported on
114 * the session bus, and GIO provides the #GDBusActionGroup wrapper to
115 * conveniently access them remotely. GIO provides a #GDBusMenuModel wrapper
116 * for remote access to exported #GMenuModels.
117 *
118 * There is a number of different entry points into a GApplication:
119 *
120 * - via 'Activate' (i.e. just starting the application)
121 *
122 * - via 'Open' (i.e. opening some files)
123 *
124 * - by handling a command-line
125 *
126 * - via activating an action
127 *
128 * The #GApplication::startup signal lets you handle the application
129 * initialization for all of these in a single place.
130 *
131 * Regardless of which of these entry points is used to start the
132 * application, GApplication passes some ‘platform data’ from the
133 * launching instance to the primary instance, in the form of a
134 * #GVariant dictionary mapping strings to variants. To use platform
135 * data, override the @before_emit or @after_emit virtual functions
136 * in your #GApplication subclass. When dealing with
137 * #GApplicationCommandLine objects, the platform data is
138 * directly available via g_application_command_line_get_cwd(),
139 * g_application_command_line_get_environ() and
140 * g_application_command_line_get_platform_data().
141 *
142 * As the name indicates, the platform data may vary depending on the
143 * operating system, but it always includes the current directory (key
144 * "cwd"), and optionally the environment (ie the set of environment
145 * variables and their values) of the calling process (key "environ").
146 * The environment is only added to the platform data if the
147 * %G_APPLICATION_SEND_ENVIRONMENT flag is set. #GApplication subclasses
148 * can add their own platform data by overriding the @add_platform_data
149 * virtual function. For instance, #GtkApplication adds startup notification
150 * data in this way.
151 *
152 * To parse commandline arguments you may handle the
153 * #GApplication::command-line signal or override the local_command_line()
154 * vfunc, to parse them in either the primary instance or the local instance,
155 * respectively.
156 *
157 * For an example of opening files with a GApplication, see
158 * [gapplication-example-open.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-open.c).
159 *
160 * For an example of using actions with GApplication, see
161 * [gapplication-example-actions.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-actions.c).
162 *
163 * For an example of using extra D-Bus hooks with GApplication, see
164 * [gapplication-example-dbushooks.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-dbushooks.c).
165 */
166
167/**
168 * GApplication:
169 *
170 * #GApplication is an opaque data structure and can only be accessed
171 * using the following functions.
172 * Since: 2.28
173 */
174
175/**
176 * GApplicationClass:
177 * @startup: invoked on the primary instance immediately after registration
178 * @shutdown: invoked only on the registered primary instance immediately
179 * after the main loop terminates
180 * @activate: invoked on the primary instance when an activation occurs
181 * @open: invoked on the primary instance when there are files to open
182 * @command_line: invoked on the primary instance when a command-line is
183 * not handled locally
184 * @local_command_line: invoked (locally). The virtual function has the chance
185 * to inspect (and possibly replace) command line arguments. See
186 * g_application_run() for more information. Also see the
187 * #GApplication::handle-local-options signal, which is a simpler
188 * alternative to handling some commandline options locally
189 * @before_emit: invoked on the primary instance before 'activate', 'open',
190 * 'command-line' or any action invocation, gets the 'platform data' from
191 * the calling instance
192 * @after_emit: invoked on the primary instance after 'activate', 'open',
193 * 'command-line' or any action invocation, gets the 'platform data' from
194 * the calling instance
195 * @add_platform_data: invoked (locally) to add 'platform data' to be sent to
196 * the primary instance when activating, opening or invoking actions
197 * @quit_mainloop: Used to be invoked on the primary instance when the use
198 * count of the application drops to zero (and after any inactivity
199 * timeout, if requested). Not used anymore since 2.32
200 * @run_mainloop: Used to be invoked on the primary instance from
201 * g_application_run() if the use-count is non-zero. Since 2.32,
202 * GApplication is iterating the main context directly and is not
203 * using @run_mainloop anymore
204 * @dbus_register: invoked locally during registration, if the application is
205 * using its D-Bus backend. You can use this to export extra objects on the
206 * bus, that need to exist before the application tries to own the bus name.
207 * The function is passed the #GDBusConnection to to session bus, and the
208 * object path that #GApplication will use to export is D-Bus API.
209 * If this function returns %TRUE, registration will proceed; otherwise
210 * registration will abort. Since: 2.34
211 * @dbus_unregister: invoked locally during unregistration, if the application
212 * is using its D-Bus backend. Use this to undo anything done by
213 * the @dbus_register vfunc. Since: 2.34
214 * @handle_local_options: invoked locally after the parsing of the commandline
215 * options has occurred. Since: 2.40
216 * @name_lost: invoked when another instance is taking over the name. Since: 2.60
217 *
218 * Virtual function table for #GApplication.
219 *
220 * Since: 2.28
221 */
222
223struct _GApplicationPrivate
224{
225 GApplicationFlags flags;
226 gchar *id;
227 gchar *resource_path;
228
229 GActionGroup *actions;
230
231 guint inactivity_timeout_id;
232 guint inactivity_timeout;
233 guint use_count;
234 guint busy_count;
235
236 guint is_registered : 1;
237 guint is_remote : 1;
238 guint did_startup : 1;
239 guint did_shutdown : 1;
240 guint must_quit_now : 1;
241
242 GRemoteActionGroup *remote_actions;
243 GApplicationImpl *impl;
244
245 GNotificationBackend *notifications;
246
247 /* GOptionContext support */
248 GOptionGroup *main_options;
249 GSList *option_groups;
250 GHashTable *packed_options;
251 gboolean options_parsed;
252 gchar *parameter_string;
253 gchar *summary;
254 gchar *description;
255
256 /* Allocated option strings, from g_application_add_main_option() */
257 GSList *option_strings;
258};
259
260enum
261{
262 PROP_NONE,
263 PROP_APPLICATION_ID,
264 PROP_FLAGS,
265 PROP_RESOURCE_BASE_PATH,
266 PROP_IS_REGISTERED,
267 PROP_IS_REMOTE,
268 PROP_INACTIVITY_TIMEOUT,
269 PROP_ACTION_GROUP,
270 PROP_IS_BUSY
271};
272
273enum
274{
275 SIGNAL_STARTUP,
276 SIGNAL_SHUTDOWN,
277 SIGNAL_ACTIVATE,
278 SIGNAL_OPEN,
279 SIGNAL_ACTION,
280 SIGNAL_COMMAND_LINE,
281 SIGNAL_HANDLE_LOCAL_OPTIONS,
282 SIGNAL_NAME_LOST,
283 NR_SIGNALS
284};
285
286static guint g_application_signals[NR_SIGNALS];
287
288static void g_application_action_group_iface_init (GActionGroupInterface *);
289static void g_application_action_map_iface_init (GActionMapInterface *);
290G_DEFINE_TYPE_WITH_CODE (GApplication, g_application, G_TYPE_OBJECT,
291 G_ADD_PRIVATE (GApplication)
292 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP, g_application_action_group_iface_init)
293 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_MAP, g_application_action_map_iface_init))
294
295/* GApplicationExportedActions {{{1 */
296
297/* We create a subclass of GSimpleActionGroup that implements
298 * GRemoteActionGroup and deals with the platform data using
299 * GApplication's before/after_emit vfuncs. This is the action group we
300 * will be exporting.
301 *
302 * We could implement GRemoteActionGroup on GApplication directly, but
303 * this would be potentially extremely confusing to have exposed as part
304 * of the public API of GApplication. We certainly don't want anyone in
305 * the same process to be calling these APIs...
306 */
307typedef GSimpleActionGroupClass GApplicationExportedActionsClass;
308typedef struct
309{
310 GSimpleActionGroup parent_instance;
311 GApplication *application;
312} GApplicationExportedActions;
313
314static GType g_application_exported_actions_get_type (void);
315static void g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface);
316G_DEFINE_TYPE_WITH_CODE (GApplicationExportedActions, g_application_exported_actions, G_TYPE_SIMPLE_ACTION_GROUP,
317 G_IMPLEMENT_INTERFACE (G_TYPE_REMOTE_ACTION_GROUP, g_application_exported_actions_iface_init))
318
319static void
320g_application_exported_actions_activate_action_full (GRemoteActionGroup *remote,
321 const gchar *action_name,
322 GVariant *parameter,
323 GVariant *platform_data)
324{
325 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
326
327 G_APPLICATION_GET_CLASS (exported->application)
328 ->before_emit (exported->application, platform_data);
329
330 g_action_group_activate_action (G_ACTION_GROUP (exported), action_name, parameter);
331
332 G_APPLICATION_GET_CLASS (exported->application)
333 ->after_emit (exported->application, platform_data);
334}
335
336static void
337g_application_exported_actions_change_action_state_full (GRemoteActionGroup *remote,
338 const gchar *action_name,
339 GVariant *value,
340 GVariant *platform_data)
341{
342 GApplicationExportedActions *exported = (GApplicationExportedActions *) remote;
343
344 G_APPLICATION_GET_CLASS (exported->application)
345 ->before_emit (exported->application, platform_data);
346
347 g_action_group_change_action_state (G_ACTION_GROUP (exported), action_name, value);
348
349 G_APPLICATION_GET_CLASS (exported->application)
350 ->after_emit (exported->application, platform_data);
351}
352
353static void
354g_application_exported_actions_init (GApplicationExportedActions *actions)
355{
356}
357
358static void
359g_application_exported_actions_iface_init (GRemoteActionGroupInterface *iface)
360{
361 iface->activate_action_full = g_application_exported_actions_activate_action_full;
362 iface->change_action_state_full = g_application_exported_actions_change_action_state_full;
363}
364
365static void
366g_application_exported_actions_class_init (GApplicationExportedActionsClass *class)
367{
368}
369
370static GActionGroup *
371g_application_exported_actions_new (GApplication *application)
372{
373 GApplicationExportedActions *actions;
374
375 actions = g_object_new (object_type: g_application_exported_actions_get_type (), NULL);
376 actions->application = application;
377
378 return G_ACTION_GROUP (actions);
379}
380
381/* Command line option handling {{{1 */
382
383static void
384free_option_entry (gpointer data)
385{
386 GOptionEntry *entry = data;
387
388 switch (entry->arg)
389 {
390 case G_OPTION_ARG_STRING:
391 case G_OPTION_ARG_FILENAME:
392 g_free (mem: *(gchar **) entry->arg_data);
393 break;
394
395 case G_OPTION_ARG_STRING_ARRAY:
396 case G_OPTION_ARG_FILENAME_ARRAY:
397 g_strfreev (str_array: *(gchar ***) entry->arg_data);
398 break;
399
400 default:
401 /* most things require no free... */
402 break;
403 }
404
405 /* ...except for the space that we allocated for it ourselves */
406 g_free (mem: entry->arg_data);
407
408 g_slice_free (GOptionEntry, entry);
409}
410
411static void
412g_application_pack_option_entries (GApplication *application,
413 GVariantDict *dict)
414{
415 GHashTableIter iter;
416 gpointer item;
417
418 g_hash_table_iter_init (iter: &iter, hash_table: application->priv->packed_options);
419 while (g_hash_table_iter_next (iter: &iter, NULL, value: &item))
420 {
421 GOptionEntry *entry = item;
422 GVariant *value = NULL;
423
424 switch (entry->arg)
425 {
426 case G_OPTION_ARG_NONE:
427 if (*(gboolean *) entry->arg_data != 2)
428 value = g_variant_new_boolean (value: *(gboolean *) entry->arg_data);
429 break;
430
431 case G_OPTION_ARG_STRING:
432 if (*(gchar **) entry->arg_data)
433 value = g_variant_new_string (string: *(gchar **) entry->arg_data);
434 break;
435
436 case G_OPTION_ARG_INT:
437 if (*(gint32 *) entry->arg_data)
438 value = g_variant_new_int32 (value: *(gint32 *) entry->arg_data);
439 break;
440
441 case G_OPTION_ARG_FILENAME:
442 if (*(gchar **) entry->arg_data)
443 value = g_variant_new_bytestring (string: *(gchar **) entry->arg_data);
444 break;
445
446 case G_OPTION_ARG_STRING_ARRAY:
447 if (*(gchar ***) entry->arg_data)
448 value = g_variant_new_strv (strv: *(const gchar ***) entry->arg_data, length: -1);
449 break;
450
451 case G_OPTION_ARG_FILENAME_ARRAY:
452 if (*(gchar ***) entry->arg_data)
453 value = g_variant_new_bytestring_array (strv: *(const gchar ***) entry->arg_data, length: -1);
454 break;
455
456 case G_OPTION_ARG_DOUBLE:
457 if (*(gdouble *) entry->arg_data)
458 value = g_variant_new_double (value: *(gdouble *) entry->arg_data);
459 break;
460
461 case G_OPTION_ARG_INT64:
462 if (*(gint64 *) entry->arg_data)
463 value = g_variant_new_int64 (value: *(gint64 *) entry->arg_data);
464 break;
465
466 default:
467 g_assert_not_reached ();
468 }
469
470 if (value)
471 g_variant_dict_insert_value (dict, key: entry->long_name, value);
472 }
473}
474
475static GVariantDict *
476g_application_parse_command_line (GApplication *application,
477 gchar ***arguments,
478 GError **error)
479{
480 gboolean become_service = FALSE;
481 gchar *app_id = NULL;
482 gboolean replace = FALSE;
483 GVariantDict *dict = NULL;
484 GOptionContext *context;
485 GOptionGroup *gapplication_group;
486
487 /* Due to the memory management of GOptionGroup we can only parse
488 * options once. That's because once you add a group to the
489 * GOptionContext there is no way to get it back again. This is fine:
490 * local_command_line() should never get invoked more than once
491 * anyway. Add a sanity check just to be sure.
492 */
493 g_return_val_if_fail (!application->priv->options_parsed, NULL);
494
495 context = g_option_context_new (parameter_string: application->priv->parameter_string);
496 g_option_context_set_summary (context, summary: application->priv->summary);
497 g_option_context_set_description (context, description: application->priv->description);
498
499 gapplication_group = g_option_group_new (name: "gapplication",
500 _("GApplication options"), _("Show GApplication options"),
501 NULL, NULL);
502 g_option_group_set_translation_domain (group: gapplication_group, GETTEXT_PACKAGE);
503 g_option_context_add_group (context, group: gapplication_group);
504
505 /* If the application has not registered local options and it has
506 * G_APPLICATION_HANDLES_COMMAND_LINE then we have to assume that
507 * their primary instance commandline handler may want to deal with
508 * the arguments. We must therefore ignore them.
509 *
510 * We must also ignore --help in this case since some applications
511 * will try to handle this from the remote side. See #737869.
512 */
513 if (application->priv->main_options == NULL && (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE))
514 {
515 g_option_context_set_ignore_unknown_options (context, TRUE);
516 g_option_context_set_help_enabled (context, FALSE);
517 }
518
519 /* Add the main option group, if it exists */
520 if (application->priv->main_options)
521 {
522 /* This consumes the main_options */
523 g_option_context_set_main_group (context, group: application->priv->main_options);
524 application->priv->main_options = NULL;
525 }
526
527 /* Add any other option groups if they exist. Adding them to the
528 * context will consume them, so we free the list as we go...
529 */
530 while (application->priv->option_groups)
531 {
532 g_option_context_add_group (context, group: application->priv->option_groups->data);
533 application->priv->option_groups = g_slist_delete_link (list: application->priv->option_groups,
534 link_: application->priv->option_groups);
535 }
536
537 /* In the case that we are not explicitly marked as a service or a
538 * launcher then we want to add the "--gapplication-service" option to
539 * allow the process to be made into a service.
540 */
541 if ((application->priv->flags & (G_APPLICATION_IS_SERVICE | G_APPLICATION_IS_LAUNCHER)) == 0)
542 {
543 GOptionEntry entries[] = {
544 { "gapplication-service", '\0', 0, G_OPTION_ARG_NONE, &become_service,
545 N_("Enter GApplication service mode (use from D-Bus service files)"), NULL },
546 { NULL }
547 };
548
549 g_option_group_add_entries (group: gapplication_group, entries);
550 }
551
552 /* Allow overriding the ID if the application allows it */
553 if (application->priv->flags & G_APPLICATION_CAN_OVERRIDE_APP_ID)
554 {
555 GOptionEntry entries[] = {
556 { "gapplication-app-id", '\0', 0, G_OPTION_ARG_STRING, &app_id,
557 N_("Override the application’s ID"), NULL },
558 { NULL }
559 };
560
561 g_option_group_add_entries (group: gapplication_group, entries);
562 }
563
564 /* Allow replacing if the application allows it */
565 if (application->priv->flags & G_APPLICATION_ALLOW_REPLACEMENT)
566 {
567 GOptionEntry entries[] = {
568 { "gapplication-replace", '\0', 0, G_OPTION_ARG_NONE, &replace,
569 N_("Replace the running instance"), NULL },
570 { NULL }
571 };
572
573 g_option_group_add_entries (group: gapplication_group, entries);
574 }
575
576 /* Now we parse... */
577 if (!g_option_context_parse_strv (context, arguments, error))
578 goto out;
579
580 /* Check for --gapplication-service */
581 if (become_service)
582 application->priv->flags |= G_APPLICATION_IS_SERVICE;
583
584 /* Check for --gapplication-app-id */
585 if (app_id)
586 g_application_set_application_id (application, application_id: app_id);
587
588 /* Check for --gapplication-replace */
589 if (replace)
590 application->priv->flags |= G_APPLICATION_REPLACE;
591
592 dict = g_variant_dict_new (NULL);
593 if (application->priv->packed_options)
594 {
595 g_application_pack_option_entries (application, dict);
596 g_hash_table_unref (hash_table: application->priv->packed_options);
597 application->priv->packed_options = NULL;
598 }
599
600out:
601 /* Make sure we don't run again */
602 application->priv->options_parsed = TRUE;
603
604 g_option_context_free (context);
605 g_free (mem: app_id);
606
607 return dict;
608}
609
610static void
611add_packed_option (GApplication *application,
612 GOptionEntry *entry)
613{
614 switch (entry->arg)
615 {
616 case G_OPTION_ARG_NONE:
617 entry->arg_data = g_new (gboolean, 1);
618 *(gboolean *) entry->arg_data = 2;
619 break;
620
621 case G_OPTION_ARG_INT:
622 entry->arg_data = g_new0 (gint, 1);
623 break;
624
625 case G_OPTION_ARG_STRING:
626 case G_OPTION_ARG_FILENAME:
627 case G_OPTION_ARG_STRING_ARRAY:
628 case G_OPTION_ARG_FILENAME_ARRAY:
629 entry->arg_data = g_new0 (gpointer, 1);
630 break;
631
632 case G_OPTION_ARG_INT64:
633 entry->arg_data = g_new0 (gint64, 1);
634 break;
635
636 case G_OPTION_ARG_DOUBLE:
637 entry->arg_data = g_new0 (gdouble, 1);
638 break;
639
640 default:
641 g_return_if_reached ();
642 }
643
644 if (!application->priv->packed_options)
645 application->priv->packed_options = g_hash_table_new_full (hash_func: g_str_hash, key_equal_func: g_str_equal, key_destroy_func: g_free, value_destroy_func: free_option_entry);
646
647 g_hash_table_insert (hash_table: application->priv->packed_options,
648 key: g_strdup (str: entry->long_name),
649 g_slice_dup (GOptionEntry, entry));
650}
651
652/**
653 * g_application_add_main_option_entries:
654 * @application: a #GApplication
655 * @entries: (array zero-terminated=1) (element-type GOptionEntry) a
656 * %NULL-terminated list of #GOptionEntrys
657 *
658 * Adds main option entries to be handled by @application.
659 *
660 * This function is comparable to g_option_context_add_main_entries().
661 *
662 * After the commandline arguments are parsed, the
663 * #GApplication::handle-local-options signal will be emitted. At this
664 * point, the application can inspect the values pointed to by @arg_data
665 * in the given #GOptionEntrys.
666 *
667 * Unlike #GOptionContext, #GApplication supports giving a %NULL
668 * @arg_data for a non-callback #GOptionEntry. This results in the
669 * argument in question being packed into a #GVariantDict which is also
670 * passed to #GApplication::handle-local-options, where it can be
671 * inspected and modified. If %G_APPLICATION_HANDLES_COMMAND_LINE is
672 * set, then the resulting dictionary is sent to the primary instance,
673 * where g_application_command_line_get_options_dict() will return it.
674 * This "packing" is done according to the type of the argument --
675 * booleans for normal flags, strings for strings, bytestrings for
676 * filenames, etc. The packing only occurs if the flag is given (ie: we
677 * do not pack a "false" #GVariant in the case that a flag is missing).
678 *
679 * In general, it is recommended that all commandline arguments are
680 * parsed locally. The options dictionary should then be used to
681 * transmit the result of the parsing to the primary instance, where
682 * g_variant_dict_lookup() can be used. For local options, it is
683 * possible to either use @arg_data in the usual way, or to consult (and
684 * potentially remove) the option from the options dictionary.
685 *
686 * This function is new in GLib 2.40. Before then, the only real choice
687 * was to send all of the commandline arguments (options and all) to the
688 * primary instance for handling. #GApplication ignored them completely
689 * on the local side. Calling this function "opts in" to the new
690 * behaviour, and in particular, means that unrecognised options will be
691 * treated as errors. Unrecognised options have never been ignored when
692 * %G_APPLICATION_HANDLES_COMMAND_LINE is unset.
693 *
694 * If #GApplication::handle-local-options needs to see the list of
695 * filenames, then the use of %G_OPTION_REMAINING is recommended. If
696 * @arg_data is %NULL then %G_OPTION_REMAINING can be used as a key into
697 * the options dictionary. If you do use %G_OPTION_REMAINING then you
698 * need to handle these arguments for yourself because once they are
699 * consumed, they will no longer be visible to the default handling
700 * (which treats them as filenames to be opened).
701 *
702 * It is important to use the proper GVariant format when retrieving
703 * the options with g_variant_dict_lookup():
704 * - for %G_OPTION_ARG_NONE, use `b`
705 * - for %G_OPTION_ARG_STRING, use `&s`
706 * - for %G_OPTION_ARG_INT, use `i`
707 * - for %G_OPTION_ARG_INT64, use `x`
708 * - for %G_OPTION_ARG_DOUBLE, use `d`
709 * - for %G_OPTION_ARG_FILENAME, use `^&ay`
710 * - for %G_OPTION_ARG_STRING_ARRAY, use `^a&s`
711 * - for %G_OPTION_ARG_FILENAME_ARRAY, use `^a&ay`
712 *
713 * Since: 2.40
714 */
715void
716g_application_add_main_option_entries (GApplication *application,
717 const GOptionEntry *entries)
718{
719 gint i;
720
721 g_return_if_fail (G_IS_APPLICATION (application));
722 g_return_if_fail (entries != NULL);
723
724 if (!application->priv->main_options)
725 {
726 application->priv->main_options = g_option_group_new (NULL, NULL, NULL, NULL, NULL);
727 g_option_group_set_translation_domain (group: application->priv->main_options, NULL);
728 }
729
730 for (i = 0; entries[i].long_name; i++)
731 {
732 GOptionEntry my_entries[2] = { { NULL }, { NULL } };
733 my_entries[0] = entries[i];
734
735 if (!my_entries[0].arg_data)
736 add_packed_option (application, entry: &my_entries[0]);
737
738 g_option_group_add_entries (group: application->priv->main_options, entries: my_entries);
739 }
740}
741
742/**
743 * g_application_add_main_option:
744 * @application: the #GApplication
745 * @long_name: the long name of an option used to specify it in a commandline
746 * @short_name: the short name of an option
747 * @flags: flags from #GOptionFlags
748 * @arg: the type of the option, as a #GOptionArg
749 * @description: the description for the option in `--help` output
750 * @arg_description: (nullable): the placeholder to use for the extra argument
751 * parsed by the option in `--help` output
752 *
753 * Add an option to be handled by @application.
754 *
755 * Calling this function is the equivalent of calling
756 * g_application_add_main_option_entries() with a single #GOptionEntry
757 * that has its arg_data member set to %NULL.
758 *
759 * The parsed arguments will be packed into a #GVariantDict which
760 * is passed to #GApplication::handle-local-options. If
761 * %G_APPLICATION_HANDLES_COMMAND_LINE is set, then it will also
762 * be sent to the primary instance. See
763 * g_application_add_main_option_entries() for more details.
764 *
765 * See #GOptionEntry for more documentation of the arguments.
766 *
767 * Since: 2.42
768 **/
769void
770g_application_add_main_option (GApplication *application,
771 const char *long_name,
772 char short_name,
773 GOptionFlags flags,
774 GOptionArg arg,
775 const char *description,
776 const char *arg_description)
777{
778 gchar *dup_string;
779 GOptionEntry my_entry[2] = {
780 { NULL, short_name, flags, arg, NULL, NULL, NULL },
781 { NULL }
782 };
783
784 g_return_if_fail (G_IS_APPLICATION (application));
785 g_return_if_fail (long_name != NULL);
786 g_return_if_fail (description != NULL);
787
788 my_entry[0].long_name = dup_string = g_strdup (str: long_name);
789 application->priv->option_strings = g_slist_prepend (list: application->priv->option_strings, data: dup_string);
790
791 my_entry[0].description = dup_string = g_strdup (str: description);
792 application->priv->option_strings = g_slist_prepend (list: application->priv->option_strings, data: dup_string);
793
794 my_entry[0].arg_description = dup_string = g_strdup (str: arg_description);
795 application->priv->option_strings = g_slist_prepend (list: application->priv->option_strings, data: dup_string);
796
797 g_application_add_main_option_entries (application, entries: my_entry);
798}
799
800/**
801 * g_application_add_option_group:
802 * @application: the #GApplication
803 * @group: (transfer full): a #GOptionGroup
804 *
805 * Adds a #GOptionGroup to the commandline handling of @application.
806 *
807 * This function is comparable to g_option_context_add_group().
808 *
809 * Unlike g_application_add_main_option_entries(), this function does
810 * not deal with %NULL @arg_data and never transmits options to the
811 * primary instance.
812 *
813 * The reason for that is because, by the time the options arrive at the
814 * primary instance, it is typically too late to do anything with them.
815 * Taking the GTK option group as an example: GTK will already have been
816 * initialised by the time the #GApplication::command-line handler runs.
817 * In the case that this is not the first-running instance of the
818 * application, the existing instance may already have been running for
819 * a very long time.
820 *
821 * This means that the options from #GOptionGroup are only really usable
822 * in the case that the instance of the application being run is the
823 * first instance. Passing options like `--display=` or `--gdk-debug=`
824 * on future runs will have no effect on the existing primary instance.
825 *
826 * Calling this function will cause the options in the supplied option
827 * group to be parsed, but it does not cause you to be "opted in" to the
828 * new functionality whereby unrecognised options are rejected even if
829 * %G_APPLICATION_HANDLES_COMMAND_LINE was given.
830 *
831 * Since: 2.40
832 **/
833void
834g_application_add_option_group (GApplication *application,
835 GOptionGroup *group)
836{
837 g_return_if_fail (G_IS_APPLICATION (application));
838 g_return_if_fail (group != NULL);
839
840 application->priv->option_groups = g_slist_prepend (list: application->priv->option_groups, data: group);
841}
842
843/**
844 * g_application_set_option_context_parameter_string:
845 * @application: the #GApplication
846 * @parameter_string: (nullable): a string which is displayed
847 * in the first line of `--help` output, after the usage summary `programname [OPTION...]`.
848 *
849 * Sets the parameter string to be used by the commandline handling of @application.
850 *
851 * This function registers the argument to be passed to g_option_context_new()
852 * when the internal #GOptionContext of @application is created.
853 *
854 * See g_option_context_new() for more information about @parameter_string.
855 *
856 * Since: 2.56
857 */
858void
859g_application_set_option_context_parameter_string (GApplication *application,
860 const gchar *parameter_string)
861{
862 g_return_if_fail (G_IS_APPLICATION (application));
863
864 g_free (mem: application->priv->parameter_string);
865 application->priv->parameter_string = g_strdup (str: parameter_string);
866}
867
868/**
869 * g_application_set_option_context_summary:
870 * @application: the #GApplication
871 * @summary: (nullable): a string to be shown in `--help` output
872 * before the list of options, or %NULL
873 *
874 * Adds a summary to the @application option context.
875 *
876 * See g_option_context_set_summary() for more information.
877 *
878 * Since: 2.56
879 */
880void
881g_application_set_option_context_summary (GApplication *application,
882 const gchar *summary)
883{
884 g_return_if_fail (G_IS_APPLICATION (application));
885
886 g_free (mem: application->priv->summary);
887 application->priv->summary = g_strdup (str: summary);
888}
889
890/**
891 * g_application_set_option_context_description:
892 * @application: the #GApplication
893 * @description: (nullable): a string to be shown in `--help` output
894 * after the list of options, or %NULL
895 *
896 * Adds a description to the @application option context.
897 *
898 * See g_option_context_set_description() for more information.
899 *
900 * Since: 2.56
901 */
902void
903g_application_set_option_context_description (GApplication *application,
904 const gchar *description)
905{
906 g_return_if_fail (G_IS_APPLICATION (application));
907
908 g_free (mem: application->priv->description);
909 application->priv->description = g_strdup (str: description);
910
911}
912
913
914/* vfunc defaults {{{1 */
915static void
916g_application_real_before_emit (GApplication *application,
917 GVariant *platform_data)
918{
919}
920
921static void
922g_application_real_after_emit (GApplication *application,
923 GVariant *platform_data)
924{
925}
926
927static void
928g_application_real_startup (GApplication *application)
929{
930 application->priv->did_startup = TRUE;
931}
932
933static void
934g_application_real_shutdown (GApplication *application)
935{
936 application->priv->did_shutdown = TRUE;
937}
938
939static void
940g_application_real_activate (GApplication *application)
941{
942 if (!g_signal_has_handler_pending (instance: application,
943 signal_id: g_application_signals[SIGNAL_ACTIVATE],
944 detail: 0, TRUE) &&
945 G_APPLICATION_GET_CLASS (application)->activate == g_application_real_activate)
946 {
947 static gboolean warned;
948
949 if (warned)
950 return;
951
952 g_warning ("Your application does not implement "
953 "g_application_activate() and has no handlers connected "
954 "to the 'activate' signal. It should do one of these.");
955 warned = TRUE;
956 }
957}
958
959static void
960g_application_real_open (GApplication *application,
961 GFile **files,
962 gint n_files,
963 const gchar *hint)
964{
965 if (!g_signal_has_handler_pending (instance: application,
966 signal_id: g_application_signals[SIGNAL_OPEN],
967 detail: 0, TRUE) &&
968 G_APPLICATION_GET_CLASS (application)->open == g_application_real_open)
969 {
970 static gboolean warned;
971
972 if (warned)
973 return;
974
975 g_warning ("Your application claims to support opening files "
976 "but does not implement g_application_open() and has no "
977 "handlers connected to the 'open' signal.");
978 warned = TRUE;
979 }
980}
981
982static int
983g_application_real_command_line (GApplication *application,
984 GApplicationCommandLine *cmdline)
985{
986 if (!g_signal_has_handler_pending (instance: application,
987 signal_id: g_application_signals[SIGNAL_COMMAND_LINE],
988 detail: 0, TRUE) &&
989 G_APPLICATION_GET_CLASS (application)->command_line == g_application_real_command_line)
990 {
991 static gboolean warned;
992
993 if (warned)
994 return 1;
995
996 g_warning ("Your application claims to support custom command line "
997 "handling but does not implement g_application_command_line() "
998 "and has no handlers connected to the 'command-line' signal.");
999
1000 warned = TRUE;
1001 }
1002
1003 return 1;
1004}
1005
1006static gint
1007g_application_real_handle_local_options (GApplication *application,
1008 GVariantDict *options)
1009{
1010 return -1;
1011}
1012
1013static GVariant *
1014get_platform_data (GApplication *application,
1015 GVariant *options)
1016{
1017 GVariantBuilder *builder;
1018 GVariant *result;
1019
1020 builder = g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
1021
1022 {
1023 gchar *cwd = g_get_current_dir ();
1024 g_variant_builder_add (builder, format_string: "{sv}", "cwd",
1025 g_variant_new_bytestring (string: cwd));
1026 g_free (mem: cwd);
1027 }
1028
1029 if (application->priv->flags & G_APPLICATION_SEND_ENVIRONMENT)
1030 {
1031 GVariant *array;
1032 gchar **envp;
1033
1034 envp = g_get_environ ();
1035 array = g_variant_new_bytestring_array (strv: (const gchar **) envp, length: -1);
1036 g_strfreev (str_array: envp);
1037
1038 g_variant_builder_add (builder, format_string: "{sv}", "environ", array);
1039 }
1040
1041 if (options)
1042 g_variant_builder_add (builder, format_string: "{sv}", "options", options);
1043
1044 G_APPLICATION_GET_CLASS (application)->
1045 add_platform_data (application, builder);
1046
1047 result = g_variant_builder_end (builder);
1048 g_variant_builder_unref (builder);
1049
1050 return result;
1051}
1052
1053static void
1054g_application_call_command_line (GApplication *application,
1055 const gchar * const *arguments,
1056 GVariant *options,
1057 gint *exit_status)
1058{
1059 if (application->priv->is_remote)
1060 {
1061 GVariant *platform_data;
1062
1063 platform_data = get_platform_data (application, options);
1064 *exit_status = g_application_impl_command_line (impl: application->priv->impl, arguments, platform_data);
1065 }
1066 else
1067 {
1068 GApplicationCommandLine *cmdline;
1069 GVariant *v;
1070
1071 v = g_variant_new_bytestring_array (strv: (const gchar **) arguments, length: -1);
1072 cmdline = g_object_new (G_TYPE_APPLICATION_COMMAND_LINE,
1073 first_property_name: "arguments", v,
1074 "options", options,
1075 NULL);
1076 g_signal_emit (instance: application, signal_id: g_application_signals[SIGNAL_COMMAND_LINE], detail: 0, cmdline, exit_status);
1077 g_object_unref (object: cmdline);
1078 }
1079}
1080
1081static gboolean
1082g_application_real_local_command_line (GApplication *application,
1083 gchar ***arguments,
1084 int *exit_status)
1085{
1086 GError *error = NULL;
1087 GVariantDict *options;
1088 gint n_args;
1089
1090 options = g_application_parse_command_line (application, arguments, error: &error);
1091 if (!options)
1092 {
1093 g_printerr (format: "%s\n", error->message);
1094 g_error_free (error);
1095 *exit_status = 1;
1096 return TRUE;
1097 }
1098
1099 g_signal_emit (instance: application, signal_id: g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS], detail: 0, options, exit_status);
1100
1101 if (*exit_status >= 0)
1102 {
1103 g_variant_dict_unref (dict: options);
1104 return TRUE;
1105 }
1106
1107 if (!g_application_register (application, NULL, error: &error))
1108 {
1109 g_printerr (format: "Failed to register: %s\n", error->message);
1110 g_variant_dict_unref (dict: options);
1111 g_error_free (error);
1112 *exit_status = 1;
1113 return TRUE;
1114 }
1115
1116 n_args = g_strv_length (str_array: *arguments);
1117
1118 if (application->priv->flags & G_APPLICATION_IS_SERVICE)
1119 {
1120 if ((*exit_status = n_args > 1))
1121 {
1122 g_printerr (format: "GApplication service mode takes no arguments.\n");
1123 application->priv->flags &= ~G_APPLICATION_IS_SERVICE;
1124 *exit_status = 1;
1125 }
1126 else
1127 *exit_status = 0;
1128 }
1129 else if (application->priv->flags & G_APPLICATION_HANDLES_COMMAND_LINE)
1130 {
1131 g_application_call_command_line (application,
1132 arguments: (const gchar **) *arguments,
1133 options: g_variant_dict_end (dict: options),
1134 exit_status);
1135 }
1136 else
1137 {
1138 if (n_args <= 1)
1139 {
1140 g_application_activate (application);
1141 *exit_status = 0;
1142 }
1143
1144 else
1145 {
1146 if (~application->priv->flags & G_APPLICATION_HANDLES_OPEN)
1147 {
1148 g_critical ("This application can not open files.");
1149 *exit_status = 1;
1150 }
1151 else
1152 {
1153 GFile **files;
1154 gint n_files;
1155 gint i;
1156
1157 n_files = n_args - 1;
1158 files = g_new (GFile *, n_files);
1159
1160 for (i = 0; i < n_files; i++)
1161 files[i] = g_file_new_for_commandline_arg (arg: (*arguments)[i + 1]);
1162
1163 g_application_open (application, files, n_files, hint: "");
1164
1165 for (i = 0; i < n_files; i++)
1166 g_object_unref (object: files[i]);
1167 g_free (mem: files);
1168
1169 *exit_status = 0;
1170 }
1171 }
1172 }
1173
1174 g_variant_dict_unref (dict: options);
1175
1176 return TRUE;
1177}
1178
1179static void
1180g_application_real_add_platform_data (GApplication *application,
1181 GVariantBuilder *builder)
1182{
1183}
1184
1185static gboolean
1186g_application_real_dbus_register (GApplication *application,
1187 GDBusConnection *connection,
1188 const gchar *object_path,
1189 GError **error)
1190{
1191 return TRUE;
1192}
1193
1194static void
1195g_application_real_dbus_unregister (GApplication *application,
1196 GDBusConnection *connection,
1197 const gchar *object_path)
1198{
1199}
1200
1201static gboolean
1202g_application_real_name_lost (GApplication *application)
1203{
1204 g_application_quit (application);
1205 return TRUE;
1206}
1207
1208/* GObject implementation stuff {{{1 */
1209static void
1210g_application_set_property (GObject *object,
1211 guint prop_id,
1212 const GValue *value,
1213 GParamSpec *pspec)
1214{
1215 GApplication *application = G_APPLICATION (object);
1216
1217 switch (prop_id)
1218 {
1219 case PROP_APPLICATION_ID:
1220 g_application_set_application_id (application,
1221 application_id: g_value_get_string (value));
1222 break;
1223
1224 case PROP_FLAGS:
1225 g_application_set_flags (application, flags: g_value_get_flags (value));
1226 break;
1227
1228 case PROP_RESOURCE_BASE_PATH:
1229 g_application_set_resource_base_path (application, resource_path: g_value_get_string (value));
1230 break;
1231
1232 case PROP_INACTIVITY_TIMEOUT:
1233 g_application_set_inactivity_timeout (application,
1234 inactivity_timeout: g_value_get_uint (value));
1235 break;
1236
1237 case PROP_ACTION_GROUP:
1238 g_clear_object (&application->priv->actions);
1239 application->priv->actions = g_value_dup_object (value);
1240 break;
1241
1242 default:
1243 g_assert_not_reached ();
1244 }
1245}
1246
1247/**
1248 * g_application_set_action_group:
1249 * @application: a #GApplication
1250 * @action_group: (nullable): a #GActionGroup, or %NULL
1251 *
1252 * This used to be how actions were associated with a #GApplication.
1253 * Now there is #GActionMap for that.
1254 *
1255 * Since: 2.28
1256 *
1257 * Deprecated:2.32:Use the #GActionMap interface instead. Never ever
1258 * mix use of this API with use of #GActionMap on the same @application
1259 * or things will go very badly wrong. This function is known to
1260 * introduce buggy behaviour (ie: signals not emitted on changes to the
1261 * action group), so you should really use #GActionMap instead.
1262 **/
1263void
1264g_application_set_action_group (GApplication *application,
1265 GActionGroup *action_group)
1266{
1267 g_return_if_fail (G_IS_APPLICATION (application));
1268 g_return_if_fail (!application->priv->is_registered);
1269
1270 if (application->priv->actions != NULL)
1271 g_object_unref (object: application->priv->actions);
1272
1273 application->priv->actions = action_group;
1274
1275 if (application->priv->actions != NULL)
1276 g_object_ref (application->priv->actions);
1277}
1278
1279static void
1280g_application_get_property (GObject *object,
1281 guint prop_id,
1282 GValue *value,
1283 GParamSpec *pspec)
1284{
1285 GApplication *application = G_APPLICATION (object);
1286
1287 switch (prop_id)
1288 {
1289 case PROP_APPLICATION_ID:
1290 g_value_set_string (value,
1291 v_string: g_application_get_application_id (application));
1292 break;
1293
1294 case PROP_FLAGS:
1295 g_value_set_flags (value,
1296 v_flags: g_application_get_flags (application));
1297 break;
1298
1299 case PROP_RESOURCE_BASE_PATH:
1300 g_value_set_string (value, v_string: g_application_get_resource_base_path (application));
1301 break;
1302
1303 case PROP_IS_REGISTERED:
1304 g_value_set_boolean (value,
1305 v_boolean: g_application_get_is_registered (application));
1306 break;
1307
1308 case PROP_IS_REMOTE:
1309 g_value_set_boolean (value,
1310 v_boolean: g_application_get_is_remote (application));
1311 break;
1312
1313 case PROP_INACTIVITY_TIMEOUT:
1314 g_value_set_uint (value,
1315 v_uint: g_application_get_inactivity_timeout (application));
1316 break;
1317
1318 case PROP_IS_BUSY:
1319 g_value_set_boolean (value, v_boolean: g_application_get_is_busy (application));
1320 break;
1321
1322 default:
1323 g_assert_not_reached ();
1324 }
1325}
1326
1327static void
1328g_application_constructed (GObject *object)
1329{
1330 GApplication *application = G_APPLICATION (object);
1331
1332 if (g_application_get_default () == NULL)
1333 g_application_set_default (application);
1334
1335 /* People should not set properties from _init... */
1336 g_assert (application->priv->resource_path == NULL);
1337
1338 if (application->priv->id != NULL)
1339 {
1340 gint i;
1341
1342 application->priv->resource_path = g_strconcat (string1: "/", application->priv->id, NULL);
1343
1344 for (i = 1; application->priv->resource_path[i]; i++)
1345 if (application->priv->resource_path[i] == '.')
1346 application->priv->resource_path[i] = '/';
1347 }
1348}
1349
1350static void
1351g_application_dispose (GObject *object)
1352{
1353 GApplication *application = G_APPLICATION (object);
1354
1355 if (application->priv->impl != NULL &&
1356 G_APPLICATION_GET_CLASS (application)->dbus_unregister != g_application_real_dbus_unregister)
1357 {
1358 static gboolean warned;
1359
1360 if (!warned)
1361 {
1362 g_warning ("Your application did not unregister from D-Bus before destruction. "
1363 "Consider using g_application_run().");
1364 }
1365
1366 warned = TRUE;
1367 }
1368
1369 G_OBJECT_CLASS (g_application_parent_class)->dispose (object);
1370}
1371
1372static void
1373g_application_finalize (GObject *object)
1374{
1375 GApplication *application = G_APPLICATION (object);
1376
1377 if (application->priv->inactivity_timeout_id)
1378 g_source_remove (tag: application->priv->inactivity_timeout_id);
1379
1380 g_slist_free_full (list: application->priv->option_groups, free_func: (GDestroyNotify) g_option_group_unref);
1381 if (application->priv->main_options)
1382 g_option_group_unref (group: application->priv->main_options);
1383 if (application->priv->packed_options)
1384 g_hash_table_unref (hash_table: application->priv->packed_options);
1385
1386 g_free (mem: application->priv->parameter_string);
1387 g_free (mem: application->priv->summary);
1388 g_free (mem: application->priv->description);
1389
1390 g_slist_free_full (list: application->priv->option_strings, free_func: g_free);
1391
1392 if (application->priv->impl)
1393 g_application_impl_destroy (impl: application->priv->impl);
1394 g_free (mem: application->priv->id);
1395
1396 if (g_application_get_default () == application)
1397 g_application_set_default (NULL);
1398
1399 if (application->priv->actions)
1400 g_object_unref (object: application->priv->actions);
1401
1402 g_clear_object (&application->priv->remote_actions);
1403
1404 if (application->priv->notifications)
1405 g_object_unref (object: application->priv->notifications);
1406
1407 g_free (mem: application->priv->resource_path);
1408
1409 G_OBJECT_CLASS (g_application_parent_class)
1410 ->finalize (object);
1411}
1412
1413static void
1414g_application_init (GApplication *application)
1415{
1416 application->priv = g_application_get_instance_private (self: application);
1417
1418 application->priv->actions = g_application_exported_actions_new (application);
1419
1420 /* application->priv->actions is the one and only ref on the group, so when
1421 * we dispose, the action group will die, disconnecting all signals.
1422 */
1423 g_signal_connect_swapped (application->priv->actions, "action-added",
1424 G_CALLBACK (g_action_group_action_added), application);
1425 g_signal_connect_swapped (application->priv->actions, "action-enabled-changed",
1426 G_CALLBACK (g_action_group_action_enabled_changed), application);
1427 g_signal_connect_swapped (application->priv->actions, "action-state-changed",
1428 G_CALLBACK (g_action_group_action_state_changed), application);
1429 g_signal_connect_swapped (application->priv->actions, "action-removed",
1430 G_CALLBACK (g_action_group_action_removed), application);
1431}
1432
1433static gboolean
1434g_application_handle_local_options_accumulator (GSignalInvocationHint *ihint,
1435 GValue *return_accu,
1436 const GValue *handler_return,
1437 gpointer dummy)
1438{
1439 gint value;
1440
1441 value = g_value_get_int (value: handler_return);
1442 g_value_set_int (value: return_accu, v_int: value);
1443
1444 return value < 0;
1445}
1446
1447static void
1448g_application_class_init (GApplicationClass *class)
1449{
1450 GObjectClass *object_class = G_OBJECT_CLASS (class);
1451
1452 object_class->constructed = g_application_constructed;
1453 object_class->dispose = g_application_dispose;
1454 object_class->finalize = g_application_finalize;
1455 object_class->get_property = g_application_get_property;
1456 object_class->set_property = g_application_set_property;
1457
1458 class->before_emit = g_application_real_before_emit;
1459 class->after_emit = g_application_real_after_emit;
1460 class->startup = g_application_real_startup;
1461 class->shutdown = g_application_real_shutdown;
1462 class->activate = g_application_real_activate;
1463 class->open = g_application_real_open;
1464 class->command_line = g_application_real_command_line;
1465 class->local_command_line = g_application_real_local_command_line;
1466 class->handle_local_options = g_application_real_handle_local_options;
1467 class->add_platform_data = g_application_real_add_platform_data;
1468 class->dbus_register = g_application_real_dbus_register;
1469 class->dbus_unregister = g_application_real_dbus_unregister;
1470 class->name_lost = g_application_real_name_lost;
1471
1472 g_object_class_install_property (oclass: object_class, property_id: PROP_APPLICATION_ID,
1473 pspec: g_param_spec_string (name: "application-id",
1474 P_("Application identifier"),
1475 P_("The unique identifier for the application"),
1476 NULL, flags: G_PARAM_READWRITE | G_PARAM_CONSTRUCT |
1477 G_PARAM_STATIC_STRINGS));
1478
1479 g_object_class_install_property (oclass: object_class, property_id: PROP_FLAGS,
1480 pspec: g_param_spec_flags (name: "flags",
1481 P_("Application flags"),
1482 P_("Flags specifying the behaviour of the application"),
1483 flags_type: G_TYPE_APPLICATION_FLAGS, default_value: G_APPLICATION_FLAGS_NONE,
1484 flags: G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1485
1486 g_object_class_install_property (oclass: object_class, property_id: PROP_RESOURCE_BASE_PATH,
1487 pspec: g_param_spec_string (name: "resource-base-path",
1488 P_("Resource base path"),
1489 P_("The base resource path for the application"),
1490 NULL, flags: G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1491
1492 g_object_class_install_property (oclass: object_class, property_id: PROP_IS_REGISTERED,
1493 pspec: g_param_spec_boolean (name: "is-registered",
1494 P_("Is registered"),
1495 P_("If g_application_register() has been called"),
1496 FALSE, flags: G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1497
1498 g_object_class_install_property (oclass: object_class, property_id: PROP_IS_REMOTE,
1499 pspec: g_param_spec_boolean (name: "is-remote",
1500 P_("Is remote"),
1501 P_("If this application instance is remote"),
1502 FALSE, flags: G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1503
1504 g_object_class_install_property (oclass: object_class, property_id: PROP_INACTIVITY_TIMEOUT,
1505 pspec: g_param_spec_uint (name: "inactivity-timeout",
1506 P_("Inactivity timeout"),
1507 P_("Time (ms) to stay alive after becoming idle"),
1508 minimum: 0, G_MAXUINT, default_value: 0,
1509 flags: G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
1510
1511 g_object_class_install_property (oclass: object_class, property_id: PROP_ACTION_GROUP,
1512 pspec: g_param_spec_object (name: "action-group",
1513 P_("Action group"),
1514 P_("The group of actions that the application exports"),
1515 G_TYPE_ACTION_GROUP,
1516 flags: G_PARAM_DEPRECATED | G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
1517
1518 /**
1519 * GApplication:is-busy:
1520 *
1521 * Whether the application is currently marked as busy through
1522 * g_application_mark_busy() or g_application_bind_busy_property().
1523 *
1524 * Since: 2.44
1525 */
1526 g_object_class_install_property (oclass: object_class, property_id: PROP_IS_BUSY,
1527 pspec: g_param_spec_boolean (name: "is-busy",
1528 P_("Is busy"),
1529 P_("If this application is currently marked busy"),
1530 FALSE, flags: G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1531
1532 /**
1533 * GApplication::startup:
1534 * @application: the application
1535 *
1536 * The ::startup signal is emitted on the primary instance immediately
1537 * after registration. See g_application_register().
1538 */
1539 g_application_signals[SIGNAL_STARTUP] =
1540 g_signal_new (I_("startup"), G_TYPE_APPLICATION, signal_flags: G_SIGNAL_RUN_FIRST,
1541 G_STRUCT_OFFSET (GApplicationClass, startup),
1542 NULL, NULL, NULL, G_TYPE_NONE, n_params: 0);
1543
1544 /**
1545 * GApplication::shutdown:
1546 * @application: the application
1547 *
1548 * The ::shutdown signal is emitted only on the registered primary instance
1549 * immediately after the main loop terminates.
1550 */
1551 g_application_signals[SIGNAL_SHUTDOWN] =
1552 g_signal_new (I_("shutdown"), G_TYPE_APPLICATION, signal_flags: G_SIGNAL_RUN_LAST,
1553 G_STRUCT_OFFSET (GApplicationClass, shutdown),
1554 NULL, NULL, NULL, G_TYPE_NONE, n_params: 0);
1555
1556 /**
1557 * GApplication::activate:
1558 * @application: the application
1559 *
1560 * The ::activate signal is emitted on the primary instance when an
1561 * activation occurs. See g_application_activate().
1562 */
1563 g_application_signals[SIGNAL_ACTIVATE] =
1564 g_signal_new (I_("activate"), G_TYPE_APPLICATION, signal_flags: G_SIGNAL_RUN_LAST,
1565 G_STRUCT_OFFSET (GApplicationClass, activate),
1566 NULL, NULL, NULL, G_TYPE_NONE, n_params: 0);
1567
1568
1569 /**
1570 * GApplication::open:
1571 * @application: the application
1572 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
1573 * @n_files: the length of @files
1574 * @hint: a hint provided by the calling instance
1575 *
1576 * The ::open signal is emitted on the primary instance when there are
1577 * files to open. See g_application_open() for more information.
1578 */
1579 g_application_signals[SIGNAL_OPEN] =
1580 g_signal_new (I_("open"), G_TYPE_APPLICATION, signal_flags: G_SIGNAL_RUN_LAST,
1581 G_STRUCT_OFFSET (GApplicationClass, open),
1582 NULL, NULL,
1583 c_marshaller: _g_cclosure_marshal_VOID__POINTER_INT_STRING,
1584 G_TYPE_NONE, n_params: 3, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_STRING);
1585 g_signal_set_va_marshaller (signal_id: g_application_signals[SIGNAL_OPEN],
1586 G_TYPE_FROM_CLASS (class),
1587 va_marshaller: _g_cclosure_marshal_VOID__POINTER_INT_STRINGv);
1588
1589 /**
1590 * GApplication::command-line:
1591 * @application: the application
1592 * @command_line: a #GApplicationCommandLine representing the
1593 * passed commandline
1594 *
1595 * The ::command-line signal is emitted on the primary instance when
1596 * a commandline is not handled locally. See g_application_run() and
1597 * the #GApplicationCommandLine documentation for more information.
1598 *
1599 * Returns: An integer that is set as the exit status for the calling
1600 * process. See g_application_command_line_set_exit_status().
1601 */
1602 g_application_signals[SIGNAL_COMMAND_LINE] =
1603 g_signal_new (I_("command-line"), G_TYPE_APPLICATION, signal_flags: G_SIGNAL_RUN_LAST,
1604 G_STRUCT_OFFSET (GApplicationClass, command_line),
1605 accumulator: g_signal_accumulator_first_wins, NULL,
1606 c_marshaller: _g_cclosure_marshal_INT__OBJECT,
1607 G_TYPE_INT, n_params: 1, G_TYPE_APPLICATION_COMMAND_LINE);
1608 g_signal_set_va_marshaller (signal_id: g_application_signals[SIGNAL_COMMAND_LINE],
1609 G_TYPE_FROM_CLASS (class),
1610 va_marshaller: _g_cclosure_marshal_INT__OBJECTv);
1611
1612 /**
1613 * GApplication::handle-local-options:
1614 * @application: the application
1615 * @options: the options dictionary
1616 *
1617 * The ::handle-local-options signal is emitted on the local instance
1618 * after the parsing of the commandline options has occurred.
1619 *
1620 * You can add options to be recognised during commandline option
1621 * parsing using g_application_add_main_option_entries() and
1622 * g_application_add_option_group().
1623 *
1624 * Signal handlers can inspect @options (along with values pointed to
1625 * from the @arg_data of an installed #GOptionEntrys) in order to
1626 * decide to perform certain actions, including direct local handling
1627 * (which may be useful for options like --version).
1628 *
1629 * In the event that the application is marked
1630 * %G_APPLICATION_HANDLES_COMMAND_LINE the "normal processing" will
1631 * send the @options dictionary to the primary instance where it can be
1632 * read with g_application_command_line_get_options_dict(). The signal
1633 * handler can modify the dictionary before returning, and the
1634 * modified dictionary will be sent.
1635 *
1636 * In the event that %G_APPLICATION_HANDLES_COMMAND_LINE is not set,
1637 * "normal processing" will treat the remaining uncollected command
1638 * line arguments as filenames or URIs. If there are no arguments,
1639 * the application is activated by g_application_activate(). One or
1640 * more arguments results in a call to g_application_open().
1641 *
1642 * If you want to handle the local commandline arguments for yourself
1643 * by converting them to calls to g_application_open() or
1644 * g_action_group_activate_action() then you must be sure to register
1645 * the application first. You should probably not call
1646 * g_application_activate() for yourself, however: just return -1 and
1647 * allow the default handler to do it for you. This will ensure that
1648 * the `--gapplication-service` switch works properly (i.e. no activation
1649 * in that case).
1650 *
1651 * Note that this signal is emitted from the default implementation of
1652 * local_command_line(). If you override that function and don't
1653 * chain up then this signal will never be emitted.
1654 *
1655 * You can override local_command_line() if you need more powerful
1656 * capabilities than what is provided here, but this should not
1657 * normally be required.
1658 *
1659 * Returns: an exit code. If you have handled your options and want
1660 * to exit the process, return a non-negative option, 0 for success,
1661 * and a positive value for failure. To continue, return -1 to let
1662 * the default option processing continue.
1663 *
1664 * Since: 2.40
1665 **/
1666 g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS] =
1667 g_signal_new (I_("handle-local-options"), G_TYPE_APPLICATION, signal_flags: G_SIGNAL_RUN_LAST,
1668 G_STRUCT_OFFSET (GApplicationClass, handle_local_options),
1669 accumulator: g_application_handle_local_options_accumulator, NULL,
1670 c_marshaller: _g_cclosure_marshal_INT__BOXED,
1671 G_TYPE_INT, n_params: 1, G_TYPE_VARIANT_DICT);
1672 g_signal_set_va_marshaller (signal_id: g_application_signals[SIGNAL_HANDLE_LOCAL_OPTIONS],
1673 G_TYPE_FROM_CLASS (class),
1674 va_marshaller: _g_cclosure_marshal_INT__BOXEDv);
1675
1676 /**
1677 * GApplication::name-lost:
1678 * @application: the application
1679 *
1680 * The ::name-lost signal is emitted only on the registered primary instance
1681 * when a new instance has taken over. This can only happen if the application
1682 * is using the %G_APPLICATION_ALLOW_REPLACEMENT flag.
1683 *
1684 * The default handler for this signal calls g_application_quit().
1685 *
1686 * Returns: %TRUE if the signal has been handled
1687 *
1688 * Since: 2.60
1689 */
1690 g_application_signals[SIGNAL_NAME_LOST] =
1691 g_signal_new (I_("name-lost"), G_TYPE_APPLICATION, signal_flags: G_SIGNAL_RUN_LAST,
1692 G_STRUCT_OFFSET (GApplicationClass, name_lost),
1693 accumulator: g_signal_accumulator_true_handled, NULL,
1694 c_marshaller: _g_cclosure_marshal_BOOLEAN__VOID,
1695 G_TYPE_BOOLEAN, n_params: 0);
1696 g_signal_set_va_marshaller (signal_id: g_application_signals[SIGNAL_NAME_LOST],
1697 G_TYPE_FROM_CLASS (class),
1698 va_marshaller: _g_cclosure_marshal_BOOLEAN__VOIDv);
1699}
1700
1701/* Application ID validity {{{1 */
1702
1703/**
1704 * g_application_id_is_valid:
1705 * @application_id: a potential application identifier
1706 *
1707 * Checks if @application_id is a valid application identifier.
1708 *
1709 * A valid ID is required for calls to g_application_new() and
1710 * g_application_set_application_id().
1711 *
1712 * Application identifiers follow the same format as
1713 * [D-Bus well-known bus names](https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus).
1714 * For convenience, the restrictions on application identifiers are
1715 * reproduced here:
1716 *
1717 * - Application identifiers are composed of 1 or more elements separated by a
1718 * period (`.`) character. All elements must contain at least one character.
1719 *
1720 * - Each element must only contain the ASCII characters `[A-Z][a-z][0-9]_-`,
1721 * with `-` discouraged in new application identifiers. Each element must not
1722 * begin with a digit.
1723 *
1724 * - Application identifiers must contain at least one `.` (period) character
1725 * (and thus at least two elements).
1726 *
1727 * - Application identifiers must not begin with a `.` (period) character.
1728 *
1729 * - Application identifiers must not exceed 255 characters.
1730 *
1731 * Note that the hyphen (`-`) character is allowed in application identifiers,
1732 * but is problematic or not allowed in various specifications and APIs that
1733 * refer to D-Bus, such as
1734 * [Flatpak application IDs](http://docs.flatpak.org/en/latest/introduction.html#identifiers),
1735 * the
1736 * [`DBusActivatable` interface in the Desktop Entry Specification](https://specifications.freedesktop.org/desktop-entry-spec/desktop-entry-spec-latest.html#dbus),
1737 * and the convention that an application's "main" interface and object path
1738 * resemble its application identifier and bus name. To avoid situations that
1739 * require special-case handling, it is recommended that new application
1740 * identifiers consistently replace hyphens with underscores.
1741 *
1742 * Like D-Bus interface names, application identifiers should start with the
1743 * reversed DNS domain name of the author of the interface (in lower-case), and
1744 * it is conventional for the rest of the application identifier to consist of
1745 * words run together, with initial capital letters.
1746 *
1747 * As with D-Bus interface names, if the author's DNS domain name contains
1748 * hyphen/minus characters they should be replaced by underscores, and if it
1749 * contains leading digits they should be escaped by prepending an underscore.
1750 * For example, if the owner of 7-zip.org used an application identifier for an
1751 * archiving application, it might be named `org._7_zip.Archiver`.
1752 *
1753 * Returns: %TRUE if @application_id is valid
1754 */
1755gboolean
1756g_application_id_is_valid (const gchar *application_id)
1757{
1758 return g_dbus_is_name (string: application_id) &&
1759 !g_dbus_is_unique_name (string: application_id);
1760}
1761
1762/* Public Constructor {{{1 */
1763/**
1764 * g_application_new:
1765 * @application_id: (nullable): the application id
1766 * @flags: the application flags
1767 *
1768 * Creates a new #GApplication instance.
1769 *
1770 * If non-%NULL, the application id must be valid. See
1771 * g_application_id_is_valid().
1772 *
1773 * If no application ID is given then some features of #GApplication
1774 * (most notably application uniqueness) will be disabled.
1775 *
1776 * Returns: a new #GApplication instance
1777 **/
1778GApplication *
1779g_application_new (const gchar *application_id,
1780 GApplicationFlags flags)
1781{
1782 g_return_val_if_fail (application_id == NULL || g_application_id_is_valid (application_id), NULL);
1783
1784 return g_object_new (G_TYPE_APPLICATION,
1785 first_property_name: "application-id", application_id,
1786 "flags", flags,
1787 NULL);
1788}
1789
1790/* Simple get/set: application id, flags, inactivity timeout {{{1 */
1791/**
1792 * g_application_get_application_id:
1793 * @application: a #GApplication
1794 *
1795 * Gets the unique identifier for @application.
1796 *
1797 * Returns: (nullable): the identifier for @application, owned by @application
1798 *
1799 * Since: 2.28
1800 **/
1801const gchar *
1802g_application_get_application_id (GApplication *application)
1803{
1804 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1805
1806 return application->priv->id;
1807}
1808
1809/**
1810 * g_application_set_application_id:
1811 * @application: a #GApplication
1812 * @application_id: (nullable): the identifier for @application
1813 *
1814 * Sets the unique identifier for @application.
1815 *
1816 * The application id can only be modified if @application has not yet
1817 * been registered.
1818 *
1819 * If non-%NULL, the application id must be valid. See
1820 * g_application_id_is_valid().
1821 *
1822 * Since: 2.28
1823 **/
1824void
1825g_application_set_application_id (GApplication *application,
1826 const gchar *application_id)
1827{
1828 g_return_if_fail (G_IS_APPLICATION (application));
1829
1830 if (g_strcmp0 (str1: application->priv->id, str2: application_id) != 0)
1831 {
1832 g_return_if_fail (application_id == NULL || g_application_id_is_valid (application_id));
1833 g_return_if_fail (!application->priv->is_registered);
1834
1835 g_free (mem: application->priv->id);
1836 application->priv->id = g_strdup (str: application_id);
1837
1838 g_object_notify (G_OBJECT (application), property_name: "application-id");
1839 }
1840}
1841
1842/**
1843 * g_application_get_flags:
1844 * @application: a #GApplication
1845 *
1846 * Gets the flags for @application.
1847 *
1848 * See #GApplicationFlags.
1849 *
1850 * Returns: the flags for @application
1851 *
1852 * Since: 2.28
1853 **/
1854GApplicationFlags
1855g_application_get_flags (GApplication *application)
1856{
1857 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1858
1859 return application->priv->flags;
1860}
1861
1862/**
1863 * g_application_set_flags:
1864 * @application: a #GApplication
1865 * @flags: the flags for @application
1866 *
1867 * Sets the flags for @application.
1868 *
1869 * The flags can only be modified if @application has not yet been
1870 * registered.
1871 *
1872 * See #GApplicationFlags.
1873 *
1874 * Since: 2.28
1875 **/
1876void
1877g_application_set_flags (GApplication *application,
1878 GApplicationFlags flags)
1879{
1880 g_return_if_fail (G_IS_APPLICATION (application));
1881
1882 if (application->priv->flags != flags)
1883 {
1884 g_return_if_fail (!application->priv->is_registered);
1885
1886 application->priv->flags = flags;
1887
1888 g_object_notify (G_OBJECT (application), property_name: "flags");
1889 }
1890}
1891
1892/**
1893 * g_application_get_resource_base_path:
1894 * @application: a #GApplication
1895 *
1896 * Gets the resource base path of @application.
1897 *
1898 * See g_application_set_resource_base_path() for more information.
1899 *
1900 * Returns: (nullable): the base resource path, if one is set
1901 *
1902 * Since: 2.42
1903 */
1904const gchar *
1905g_application_get_resource_base_path (GApplication *application)
1906{
1907 g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
1908
1909 return application->priv->resource_path;
1910}
1911
1912/**
1913 * g_application_set_resource_base_path:
1914 * @application: a #GApplication
1915 * @resource_path: (nullable): the resource path to use
1916 *
1917 * Sets (or unsets) the base resource path of @application.
1918 *
1919 * The path is used to automatically load various [application
1920 * resources][gresource] such as menu layouts and action descriptions.
1921 * The various types of resources will be found at fixed names relative
1922 * to the given base path.
1923 *
1924 * By default, the resource base path is determined from the application
1925 * ID by prefixing '/' and replacing each '.' with '/'. This is done at
1926 * the time that the #GApplication object is constructed. Changes to
1927 * the application ID after that point will not have an impact on the
1928 * resource base path.
1929 *
1930 * As an example, if the application has an ID of "org.example.app" then
1931 * the default resource base path will be "/org/example/app". If this
1932 * is a #GtkApplication (and you have not manually changed the path)
1933 * then Gtk will then search for the menus of the application at
1934 * "/org/example/app/gtk/menus.ui".
1935 *
1936 * See #GResource for more information about adding resources to your
1937 * application.
1938 *
1939 * You can disable automatic resource loading functionality by setting
1940 * the path to %NULL.
1941 *
1942 * Changing the resource base path once the application is running is
1943 * not recommended. The point at which the resource path is consulted
1944 * for forming paths for various purposes is unspecified. When writing
1945 * a sub-class of #GApplication you should either set the
1946 * #GApplication:resource-base-path property at construction time, or call
1947 * this function during the instance initialization. Alternatively, you
1948 * can call this function in the #GApplicationClass.startup virtual function,
1949 * before chaining up to the parent implementation.
1950 *
1951 * Since: 2.42
1952 */
1953void
1954g_application_set_resource_base_path (GApplication *application,
1955 const gchar *resource_path)
1956{
1957 g_return_if_fail (G_IS_APPLICATION (application));
1958 g_return_if_fail (resource_path == NULL || g_str_has_prefix (resource_path, "/"));
1959
1960 if (g_strcmp0 (str1: application->priv->resource_path, str2: resource_path) != 0)
1961 {
1962 g_free (mem: application->priv->resource_path);
1963
1964 application->priv->resource_path = g_strdup (str: resource_path);
1965
1966 g_object_notify (G_OBJECT (application), property_name: "resource-base-path");
1967 }
1968}
1969
1970/**
1971 * g_application_get_inactivity_timeout:
1972 * @application: a #GApplication
1973 *
1974 * Gets the current inactivity timeout for the application.
1975 *
1976 * This is the amount of time (in milliseconds) after the last call to
1977 * g_application_release() before the application stops running.
1978 *
1979 * Returns: the timeout, in milliseconds
1980 *
1981 * Since: 2.28
1982 **/
1983guint
1984g_application_get_inactivity_timeout (GApplication *application)
1985{
1986 g_return_val_if_fail (G_IS_APPLICATION (application), 0);
1987
1988 return application->priv->inactivity_timeout;
1989}
1990
1991/**
1992 * g_application_set_inactivity_timeout:
1993 * @application: a #GApplication
1994 * @inactivity_timeout: the timeout, in milliseconds
1995 *
1996 * Sets the current inactivity timeout for the application.
1997 *
1998 * This is the amount of time (in milliseconds) after the last call to
1999 * g_application_release() before the application stops running.
2000 *
2001 * This call has no side effects of its own. The value set here is only
2002 * used for next time g_application_release() drops the use count to
2003 * zero. Any timeouts currently in progress are not impacted.
2004 *
2005 * Since: 2.28
2006 **/
2007void
2008g_application_set_inactivity_timeout (GApplication *application,
2009 guint inactivity_timeout)
2010{
2011 g_return_if_fail (G_IS_APPLICATION (application));
2012
2013 if (application->priv->inactivity_timeout != inactivity_timeout)
2014 {
2015 application->priv->inactivity_timeout = inactivity_timeout;
2016
2017 g_object_notify (G_OBJECT (application), property_name: "inactivity-timeout");
2018 }
2019}
2020/* Read-only property getters (is registered, is remote, dbus stuff) {{{1 */
2021/**
2022 * g_application_get_is_registered:
2023 * @application: a #GApplication
2024 *
2025 * Checks if @application is registered.
2026 *
2027 * An application is registered if g_application_register() has been
2028 * successfully called.
2029 *
2030 * Returns: %TRUE if @application is registered
2031 *
2032 * Since: 2.28
2033 **/
2034gboolean
2035g_application_get_is_registered (GApplication *application)
2036{
2037 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2038
2039 return application->priv->is_registered;
2040}
2041
2042/**
2043 * g_application_get_is_remote:
2044 * @application: a #GApplication
2045 *
2046 * Checks if @application is remote.
2047 *
2048 * If @application is remote then it means that another instance of
2049 * application already exists (the 'primary' instance). Calls to
2050 * perform actions on @application will result in the actions being
2051 * performed by the primary instance.
2052 *
2053 * The value of this property cannot be accessed before
2054 * g_application_register() has been called. See
2055 * g_application_get_is_registered().
2056 *
2057 * Returns: %TRUE if @application is remote
2058 *
2059 * Since: 2.28
2060 **/
2061gboolean
2062g_application_get_is_remote (GApplication *application)
2063{
2064 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2065 g_return_val_if_fail (application->priv->is_registered, FALSE);
2066
2067 return application->priv->is_remote;
2068}
2069
2070/**
2071 * g_application_get_dbus_connection:
2072 * @application: a #GApplication
2073 *
2074 * Gets the #GDBusConnection being used by the application, or %NULL.
2075 *
2076 * If #GApplication is using its D-Bus backend then this function will
2077 * return the #GDBusConnection being used for uniqueness and
2078 * communication with the desktop environment and other instances of the
2079 * application.
2080 *
2081 * If #GApplication is not using D-Bus then this function will return
2082 * %NULL. This includes the situation where the D-Bus backend would
2083 * normally be in use but we were unable to connect to the bus.
2084 *
2085 * This function must not be called before the application has been
2086 * registered. See g_application_get_is_registered().
2087 *
2088 * Returns: (nullable) (transfer none): a #GDBusConnection, or %NULL
2089 *
2090 * Since: 2.34
2091 **/
2092GDBusConnection *
2093g_application_get_dbus_connection (GApplication *application)
2094{
2095 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2096 g_return_val_if_fail (application->priv->is_registered, FALSE);
2097
2098 return g_application_impl_get_dbus_connection (impl: application->priv->impl);
2099}
2100
2101/**
2102 * g_application_get_dbus_object_path:
2103 * @application: a #GApplication
2104 *
2105 * Gets the D-Bus object path being used by the application, or %NULL.
2106 *
2107 * If #GApplication is using its D-Bus backend then this function will
2108 * return the D-Bus object path that #GApplication is using. If the
2109 * application is the primary instance then there is an object published
2110 * at this path. If the application is not the primary instance then
2111 * the result of this function is undefined.
2112 *
2113 * If #GApplication is not using D-Bus then this function will return
2114 * %NULL. This includes the situation where the D-Bus backend would
2115 * normally be in use but we were unable to connect to the bus.
2116 *
2117 * This function must not be called before the application has been
2118 * registered. See g_application_get_is_registered().
2119 *
2120 * Returns: (nullable): the object path, or %NULL
2121 *
2122 * Since: 2.34
2123 **/
2124const gchar *
2125g_application_get_dbus_object_path (GApplication *application)
2126{
2127 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2128 g_return_val_if_fail (application->priv->is_registered, FALSE);
2129
2130 return g_application_impl_get_dbus_object_path (impl: application->priv->impl);
2131}
2132
2133
2134/* Register {{{1 */
2135/**
2136 * g_application_register:
2137 * @application: a #GApplication
2138 * @cancellable: (nullable): a #GCancellable, or %NULL
2139 * @error: a pointer to a NULL #GError, or %NULL
2140 *
2141 * Attempts registration of the application.
2142 *
2143 * This is the point at which the application discovers if it is the
2144 * primary instance or merely acting as a remote for an already-existing
2145 * primary instance. This is implemented by attempting to acquire the
2146 * application identifier as a unique bus name on the session bus using
2147 * GDBus.
2148 *
2149 * If there is no application ID or if %G_APPLICATION_NON_UNIQUE was
2150 * given, then this process will always become the primary instance.
2151 *
2152 * Due to the internal architecture of GDBus, method calls can be
2153 * dispatched at any time (even if a main loop is not running). For
2154 * this reason, you must ensure that any object paths that you wish to
2155 * register are registered before calling this function.
2156 *
2157 * If the application has already been registered then %TRUE is
2158 * returned with no work performed.
2159 *
2160 * The #GApplication::startup signal is emitted if registration succeeds
2161 * and @application is the primary instance (including the non-unique
2162 * case).
2163 *
2164 * In the event of an error (such as @cancellable being cancelled, or a
2165 * failure to connect to the session bus), %FALSE is returned and @error
2166 * is set appropriately.
2167 *
2168 * Note: the return value of this function is not an indicator that this
2169 * instance is or is not the primary instance of the application. See
2170 * g_application_get_is_remote() for that.
2171 *
2172 * Returns: %TRUE if registration succeeded
2173 *
2174 * Since: 2.28
2175 **/
2176gboolean
2177g_application_register (GApplication *application,
2178 GCancellable *cancellable,
2179 GError **error)
2180{
2181 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2182
2183 if (!application->priv->is_registered)
2184 {
2185 if (application->priv->id == NULL)
2186 application->priv->flags |= G_APPLICATION_NON_UNIQUE;
2187
2188 application->priv->impl =
2189 g_application_impl_register (application, appid: application->priv->id,
2190 flags: application->priv->flags,
2191 exported_actions: application->priv->actions,
2192 remote_actions: &application->priv->remote_actions,
2193 cancellable, error);
2194
2195 if (application->priv->impl == NULL)
2196 return FALSE;
2197
2198 application->priv->is_remote = application->priv->remote_actions != NULL;
2199 application->priv->is_registered = TRUE;
2200
2201 g_object_notify (G_OBJECT (application), property_name: "is-registered");
2202
2203 if (!application->priv->is_remote)
2204 {
2205 g_signal_emit (instance: application, signal_id: g_application_signals[SIGNAL_STARTUP], detail: 0);
2206
2207 if (!application->priv->did_startup)
2208 g_critical ("GApplication subclass '%s' failed to chain up on"
2209 " ::startup (from start of override function)",
2210 G_OBJECT_TYPE_NAME (application));
2211 }
2212 }
2213
2214 return TRUE;
2215}
2216
2217/* Hold/release {{{1 */
2218/**
2219 * g_application_hold:
2220 * @application: a #GApplication
2221 *
2222 * Increases the use count of @application.
2223 *
2224 * Use this function to indicate that the application has a reason to
2225 * continue to run. For example, g_application_hold() is called by GTK+
2226 * when a toplevel window is on the screen.
2227 *
2228 * To cancel the hold, call g_application_release().
2229 **/
2230void
2231g_application_hold (GApplication *application)
2232{
2233 g_return_if_fail (G_IS_APPLICATION (application));
2234
2235 if (application->priv->inactivity_timeout_id)
2236 {
2237 g_source_remove (tag: application->priv->inactivity_timeout_id);
2238 application->priv->inactivity_timeout_id = 0;
2239 }
2240
2241 application->priv->use_count++;
2242}
2243
2244static gboolean
2245inactivity_timeout_expired (gpointer data)
2246{
2247 GApplication *application = G_APPLICATION (data);
2248
2249 application->priv->inactivity_timeout_id = 0;
2250
2251 return G_SOURCE_REMOVE;
2252}
2253
2254
2255/**
2256 * g_application_release:
2257 * @application: a #GApplication
2258 *
2259 * Decrease the use count of @application.
2260 *
2261 * When the use count reaches zero, the application will stop running.
2262 *
2263 * Never call this function except to cancel the effect of a previous
2264 * call to g_application_hold().
2265 **/
2266void
2267g_application_release (GApplication *application)
2268{
2269 g_return_if_fail (G_IS_APPLICATION (application));
2270 g_return_if_fail (application->priv->use_count > 0);
2271
2272 application->priv->use_count--;
2273
2274 if (application->priv->use_count == 0 && application->priv->inactivity_timeout)
2275 application->priv->inactivity_timeout_id = g_timeout_add (interval: application->priv->inactivity_timeout,
2276 function: inactivity_timeout_expired, data: application);
2277}
2278
2279/* Activate, Open {{{1 */
2280/**
2281 * g_application_activate:
2282 * @application: a #GApplication
2283 *
2284 * Activates the application.
2285 *
2286 * In essence, this results in the #GApplication::activate signal being
2287 * emitted in the primary instance.
2288 *
2289 * The application must be registered before calling this function.
2290 *
2291 * Since: 2.28
2292 **/
2293void
2294g_application_activate (GApplication *application)
2295{
2296 g_return_if_fail (G_IS_APPLICATION (application));
2297 g_return_if_fail (application->priv->is_registered);
2298
2299 if (application->priv->is_remote)
2300 g_application_impl_activate (impl: application->priv->impl,
2301 platform_data: get_platform_data (application, NULL));
2302
2303 else
2304 g_signal_emit (instance: application, signal_id: g_application_signals[SIGNAL_ACTIVATE], detail: 0);
2305}
2306
2307/**
2308 * g_application_open:
2309 * @application: a #GApplication
2310 * @files: (array length=n_files): an array of #GFiles to open
2311 * @n_files: the length of the @files array
2312 * @hint: a hint (or ""), but never %NULL
2313 *
2314 * Opens the given files.
2315 *
2316 * In essence, this results in the #GApplication::open signal being emitted
2317 * in the primary instance.
2318 *
2319 * @n_files must be greater than zero.
2320 *
2321 * @hint is simply passed through to the ::open signal. It is
2322 * intended to be used by applications that have multiple modes for
2323 * opening files (eg: "view" vs "edit", etc). Unless you have a need
2324 * for this functionality, you should use "".
2325 *
2326 * The application must be registered before calling this function
2327 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
2328 *
2329 * Since: 2.28
2330 **/
2331void
2332g_application_open (GApplication *application,
2333 GFile **files,
2334 gint n_files,
2335 const gchar *hint)
2336{
2337 g_return_if_fail (G_IS_APPLICATION (application));
2338 g_return_if_fail (application->priv->flags &
2339 G_APPLICATION_HANDLES_OPEN);
2340 g_return_if_fail (application->priv->is_registered);
2341
2342 if (application->priv->is_remote)
2343 g_application_impl_open (impl: application->priv->impl,
2344 files, n_files, hint,
2345 platform_data: get_platform_data (application, NULL));
2346
2347 else
2348 g_signal_emit (instance: application, signal_id: g_application_signals[SIGNAL_OPEN],
2349 detail: 0, files, n_files, hint);
2350}
2351
2352/* Run {{{1 */
2353/**
2354 * g_application_run:
2355 * @application: a #GApplication
2356 * @argc: the argc from main() (or 0 if @argv is %NULL)
2357 * @argv: (array length=argc) (element-type filename) (nullable):
2358 * the argv from main(), or %NULL
2359 *
2360 * Runs the application.
2361 *
2362 * This function is intended to be run from main() and its return value
2363 * is intended to be returned by main(). Although you are expected to pass
2364 * the @argc, @argv parameters from main() to this function, it is possible
2365 * to pass %NULL if @argv is not available or commandline handling is not
2366 * required. Note that on Windows, @argc and @argv are ignored, and
2367 * g_win32_get_command_line() is called internally (for proper support
2368 * of Unicode commandline arguments).
2369 *
2370 * #GApplication will attempt to parse the commandline arguments. You
2371 * can add commandline flags to the list of recognised options by way of
2372 * g_application_add_main_option_entries(). After this, the
2373 * #GApplication::handle-local-options signal is emitted, from which the
2374 * application can inspect the values of its #GOptionEntrys.
2375 *
2376 * #GApplication::handle-local-options is a good place to handle options
2377 * such as `--version`, where an immediate reply from the local process is
2378 * desired (instead of communicating with an already-running instance).
2379 * A #GApplication::handle-local-options handler can stop further processing
2380 * by returning a non-negative value, which then becomes the exit status of
2381 * the process.
2382 *
2383 * What happens next depends on the flags: if
2384 * %G_APPLICATION_HANDLES_COMMAND_LINE was specified then the remaining
2385 * commandline arguments are sent to the primary instance, where a
2386 * #GApplication::command-line signal is emitted. Otherwise, the
2387 * remaining commandline arguments are assumed to be a list of files.
2388 * If there are no files listed, the application is activated via the
2389 * #GApplication::activate signal. If there are one or more files, and
2390 * %G_APPLICATION_HANDLES_OPEN was specified then the files are opened
2391 * via the #GApplication::open signal.
2392 *
2393 * If you are interested in doing more complicated local handling of the
2394 * commandline then you should implement your own #GApplication subclass
2395 * and override local_command_line(). In this case, you most likely want
2396 * to return %TRUE from your local_command_line() implementation to
2397 * suppress the default handling. See
2398 * [gapplication-example-cmdline2.c][gapplication-example-cmdline2]
2399 * for an example.
2400 *
2401 * If, after the above is done, the use count of the application is zero
2402 * then the exit status is returned immediately. If the use count is
2403 * non-zero then the default main context is iterated until the use count
2404 * falls to zero, at which point 0 is returned.
2405 *
2406 * If the %G_APPLICATION_IS_SERVICE flag is set, then the service will
2407 * run for as much as 10 seconds with a use count of zero while waiting
2408 * for the message that caused the activation to arrive. After that,
2409 * if the use count falls to zero the application will exit immediately,
2410 * except in the case that g_application_set_inactivity_timeout() is in
2411 * use.
2412 *
2413 * This function sets the prgname (g_set_prgname()), if not already set,
2414 * to the basename of argv[0].
2415 *
2416 * Much like g_main_loop_run(), this function will acquire the main context
2417 * for the duration that the application is running.
2418 *
2419 * Since 2.40, applications that are not explicitly flagged as services
2420 * or launchers (ie: neither %G_APPLICATION_IS_SERVICE or
2421 * %G_APPLICATION_IS_LAUNCHER are given as flags) will check (from the
2422 * default handler for local_command_line) if "--gapplication-service"
2423 * was given in the command line. If this flag is present then normal
2424 * commandline processing is interrupted and the
2425 * %G_APPLICATION_IS_SERVICE flag is set. This provides a "compromise"
2426 * solution whereby running an application directly from the commandline
2427 * will invoke it in the normal way (which can be useful for debugging)
2428 * while still allowing applications to be D-Bus activated in service
2429 * mode. The D-Bus service file should invoke the executable with
2430 * "--gapplication-service" as the sole commandline argument. This
2431 * approach is suitable for use by most graphical applications but
2432 * should not be used from applications like editors that need precise
2433 * control over when processes invoked via the commandline will exit and
2434 * what their exit status will be.
2435 *
2436 * Returns: the exit status
2437 *
2438 * Since: 2.28
2439 **/
2440int
2441g_application_run (GApplication *application,
2442 int argc,
2443 char **argv)
2444{
2445 gchar **arguments;
2446 int status;
2447 GMainContext *context;
2448 gboolean acquired_context;
2449
2450 g_return_val_if_fail (G_IS_APPLICATION (application), 1);
2451 g_return_val_if_fail (argc == 0 || argv != NULL, 1);
2452 g_return_val_if_fail (!application->priv->must_quit_now, 1);
2453
2454#ifdef G_OS_WIN32
2455 {
2456 gint new_argc = 0;
2457
2458 arguments = g_win32_get_command_line ();
2459
2460 /*
2461 * CommandLineToArgvW(), which is called by g_win32_get_command_line(),
2462 * pulls in the whole command line that is used to call the program. This is
2463 * fine in cases where the program is a .exe program, but in the cases where the
2464 * program is a called via a script, such as PyGObject's gtk-demo.py, which is normally
2465 * called using 'python gtk-demo.py' on Windows, the program name (argv[0])
2466 * returned by g_win32_get_command_line() will not be the argv[0] that ->local_command_line()
2467 * would expect, causing the program to fail with "This application can not open files."
2468 */
2469 new_argc = g_strv_length (arguments);
2470
2471 if (new_argc > argc)
2472 {
2473 gint i;
2474
2475 for (i = 0; i < new_argc - argc; i++)
2476 g_free (arguments[i]);
2477
2478 memmove (&arguments[0],
2479 &arguments[new_argc - argc],
2480 sizeof (arguments[0]) * (argc + 1));
2481 }
2482 }
2483#elif defined(__APPLE__)
2484 {
2485 gint i, j;
2486
2487 /*
2488 * OSX adds an unexpected parameter on the format -psn_X_XXXXXX
2489 * when opening the application using Launch Services. In order
2490 * to avoid that GOption fails to parse this parameter we just
2491 * skip it if it was provided.
2492 * See: https://gitlab.gnome.org/GNOME/glib/issues/1784
2493 */
2494 arguments = g_new (gchar *, argc + 1);
2495 for (i = 0, j = 0; i < argc; i++)
2496 {
2497 if (!g_str_has_prefix (argv[i], "-psn_"))
2498 {
2499 arguments[j] = g_strdup (argv[i]);
2500 j++;
2501 }
2502 }
2503 arguments[j] = NULL;
2504 }
2505#else
2506 {
2507 gint i;
2508
2509 arguments = g_new (gchar *, argc + 1);
2510 for (i = 0; i < argc; i++)
2511 arguments[i] = g_strdup (str: argv[i]);
2512 arguments[i] = NULL;
2513 }
2514#endif
2515
2516 if (g_get_prgname () == NULL && argc > 0)
2517 {
2518 gchar *prgname;
2519
2520 prgname = g_path_get_basename (file_name: argv[0]);
2521 g_set_prgname (prgname);
2522 g_free (mem: prgname);
2523 }
2524
2525 context = g_main_context_default ();
2526 acquired_context = g_main_context_acquire (context);
2527 g_return_val_if_fail (acquired_context, 0);
2528
2529 if (!G_APPLICATION_GET_CLASS (application)
2530 ->local_command_line (application, &arguments, &status))
2531 {
2532 GError *error = NULL;
2533
2534 if (!g_application_register (application, NULL, error: &error))
2535 {
2536 g_printerr (format: "Failed to register: %s\n", error->message);
2537 g_error_free (error);
2538 return 1;
2539 }
2540
2541 g_application_call_command_line (application, arguments: (const gchar **) arguments, NULL, exit_status: &status);
2542 }
2543
2544 g_strfreev (str_array: arguments);
2545
2546 if (application->priv->flags & G_APPLICATION_IS_SERVICE &&
2547 application->priv->is_registered &&
2548 !application->priv->use_count &&
2549 !application->priv->inactivity_timeout_id)
2550 {
2551 application->priv->inactivity_timeout_id =
2552 g_timeout_add (interval: 10000, function: inactivity_timeout_expired, data: application);
2553 }
2554
2555 while (application->priv->use_count || application->priv->inactivity_timeout_id)
2556 {
2557 if (application->priv->must_quit_now)
2558 break;
2559
2560 g_main_context_iteration (context, TRUE);
2561 status = 0;
2562 }
2563
2564 if (application->priv->is_registered && !application->priv->is_remote)
2565 {
2566 g_signal_emit (instance: application, signal_id: g_application_signals[SIGNAL_SHUTDOWN], detail: 0);
2567
2568 if (!application->priv->did_shutdown)
2569 g_critical ("GApplication subclass '%s' failed to chain up on"
2570 " ::shutdown (from end of override function)",
2571 G_OBJECT_TYPE_NAME (application));
2572 }
2573
2574 if (application->priv->impl)
2575 {
2576 g_application_impl_flush (impl: application->priv->impl);
2577 g_application_impl_destroy (impl: application->priv->impl);
2578 application->priv->impl = NULL;
2579 }
2580
2581 g_settings_sync ();
2582
2583 if (!application->priv->must_quit_now)
2584 while (g_main_context_iteration (context, FALSE))
2585 ;
2586
2587 g_main_context_release (context);
2588
2589 return status;
2590}
2591
2592static gchar **
2593g_application_list_actions (GActionGroup *action_group)
2594{
2595 GApplication *application = G_APPLICATION (action_group);
2596
2597 g_return_val_if_fail (application->priv->is_registered, NULL);
2598
2599 if (application->priv->remote_actions != NULL)
2600 return g_action_group_list_actions (G_ACTION_GROUP (application->priv->remote_actions));
2601
2602 else if (application->priv->actions != NULL)
2603 return g_action_group_list_actions (action_group: application->priv->actions);
2604
2605 else
2606 /* empty string array */
2607 return g_new0 (gchar *, 1);
2608}
2609
2610static gboolean
2611g_application_query_action (GActionGroup *group,
2612 const gchar *action_name,
2613 gboolean *enabled,
2614 const GVariantType **parameter_type,
2615 const GVariantType **state_type,
2616 GVariant **state_hint,
2617 GVariant **state)
2618{
2619 GApplication *application = G_APPLICATION (group);
2620
2621 g_return_val_if_fail (application->priv->is_registered, FALSE);
2622
2623 if (application->priv->remote_actions != NULL)
2624 return g_action_group_query_action (G_ACTION_GROUP (application->priv->remote_actions),
2625 action_name,
2626 enabled,
2627 parameter_type,
2628 state_type,
2629 state_hint,
2630 state);
2631
2632 if (application->priv->actions != NULL)
2633 return g_action_group_query_action (action_group: application->priv->actions,
2634 action_name,
2635 enabled,
2636 parameter_type,
2637 state_type,
2638 state_hint,
2639 state);
2640
2641 return FALSE;
2642}
2643
2644static void
2645g_application_change_action_state (GActionGroup *action_group,
2646 const gchar *action_name,
2647 GVariant *value)
2648{
2649 GApplication *application = G_APPLICATION (action_group);
2650
2651 g_return_if_fail (application->priv->is_remote ||
2652 application->priv->actions != NULL);
2653 g_return_if_fail (application->priv->is_registered);
2654
2655 if (application->priv->remote_actions)
2656 g_remote_action_group_change_action_state_full (remote: application->priv->remote_actions,
2657 action_name, value, platform_data: get_platform_data (application, NULL));
2658
2659 else
2660 g_action_group_change_action_state (action_group: application->priv->actions, action_name, value);
2661}
2662
2663static void
2664g_application_activate_action (GActionGroup *action_group,
2665 const gchar *action_name,
2666 GVariant *parameter)
2667{
2668 GApplication *application = G_APPLICATION (action_group);
2669
2670 g_return_if_fail (application->priv->is_remote ||
2671 application->priv->actions != NULL);
2672 g_return_if_fail (application->priv->is_registered);
2673
2674 if (application->priv->remote_actions)
2675 g_remote_action_group_activate_action_full (remote: application->priv->remote_actions,
2676 action_name, parameter, platform_data: get_platform_data (application, NULL));
2677
2678 else
2679 g_action_group_activate_action (action_group: application->priv->actions, action_name, parameter);
2680}
2681
2682static GAction *
2683g_application_lookup_action (GActionMap *action_map,
2684 const gchar *action_name)
2685{
2686 GApplication *application = G_APPLICATION (action_map);
2687
2688 g_return_val_if_fail (G_IS_ACTION_MAP (application->priv->actions), NULL);
2689
2690 return g_action_map_lookup_action (G_ACTION_MAP (application->priv->actions), action_name);
2691}
2692
2693static void
2694g_application_add_action (GActionMap *action_map,
2695 GAction *action)
2696{
2697 GApplication *application = G_APPLICATION (action_map);
2698
2699 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2700
2701 g_action_map_add_action (G_ACTION_MAP (application->priv->actions), action);
2702}
2703
2704static void
2705g_application_remove_action (GActionMap *action_map,
2706 const gchar *action_name)
2707{
2708 GApplication *application = G_APPLICATION (action_map);
2709
2710 g_return_if_fail (G_IS_ACTION_MAP (application->priv->actions));
2711
2712 g_action_map_remove_action (G_ACTION_MAP (application->priv->actions), action_name);
2713}
2714
2715static void
2716g_application_action_group_iface_init (GActionGroupInterface *iface)
2717{
2718 iface->list_actions = g_application_list_actions;
2719 iface->query_action = g_application_query_action;
2720 iface->change_action_state = g_application_change_action_state;
2721 iface->activate_action = g_application_activate_action;
2722}
2723
2724static void
2725g_application_action_map_iface_init (GActionMapInterface *iface)
2726{
2727 iface->lookup_action = g_application_lookup_action;
2728 iface->add_action = g_application_add_action;
2729 iface->remove_action = g_application_remove_action;
2730}
2731
2732/* Default Application {{{1 */
2733
2734static GApplication *default_app;
2735
2736/**
2737 * g_application_get_default:
2738 *
2739 * Returns the default #GApplication instance for this process.
2740 *
2741 * Normally there is only one #GApplication per process and it becomes
2742 * the default when it is created. You can exercise more control over
2743 * this by using g_application_set_default().
2744 *
2745 * If there is no default application then %NULL is returned.
2746 *
2747 * Returns: (nullable) (transfer none): the default application for this process, or %NULL
2748 *
2749 * Since: 2.32
2750 **/
2751GApplication *
2752g_application_get_default (void)
2753{
2754 return default_app;
2755}
2756
2757/**
2758 * g_application_set_default:
2759 * @application: (nullable): the application to set as default, or %NULL
2760 *
2761 * Sets or unsets the default application for the process, as returned
2762 * by g_application_get_default().
2763 *
2764 * This function does not take its own reference on @application. If
2765 * @application is destroyed then the default application will revert
2766 * back to %NULL.
2767 *
2768 * Since: 2.32
2769 **/
2770void
2771g_application_set_default (GApplication *application)
2772{
2773 default_app = application;
2774}
2775
2776/**
2777 * g_application_quit:
2778 * @application: a #GApplication
2779 *
2780 * Immediately quits the application.
2781 *
2782 * Upon return to the mainloop, g_application_run() will return,
2783 * calling only the 'shutdown' function before doing so.
2784 *
2785 * The hold count is ignored.
2786 * Take care if your code has called g_application_hold() on the application and
2787 * is therefore still expecting it to exist.
2788 * (Note that you may have called g_application_hold() indirectly, for example
2789 * through gtk_application_add_window().)
2790 *
2791 * The result of calling g_application_run() again after it returns is
2792 * unspecified.
2793 *
2794 * Since: 2.32
2795 **/
2796void
2797g_application_quit (GApplication *application)
2798{
2799 g_return_if_fail (G_IS_APPLICATION (application));
2800
2801 application->priv->must_quit_now = TRUE;
2802}
2803
2804/**
2805 * g_application_mark_busy:
2806 * @application: a #GApplication
2807 *
2808 * Increases the busy count of @application.
2809 *
2810 * Use this function to indicate that the application is busy, for instance
2811 * while a long running operation is pending.
2812 *
2813 * The busy state will be exposed to other processes, so a session shell will
2814 * use that information to indicate the state to the user (e.g. with a
2815 * spinner).
2816 *
2817 * To cancel the busy indication, use g_application_unmark_busy().
2818 *
2819 * Since: 2.38
2820 **/
2821void
2822g_application_mark_busy (GApplication *application)
2823{
2824 gboolean was_busy;
2825
2826 g_return_if_fail (G_IS_APPLICATION (application));
2827
2828 was_busy = (application->priv->busy_count > 0);
2829 application->priv->busy_count++;
2830
2831 if (!was_busy)
2832 {
2833 g_application_impl_set_busy_state (impl: application->priv->impl, TRUE);
2834 g_object_notify (G_OBJECT (application), property_name: "is-busy");
2835 }
2836}
2837
2838/**
2839 * g_application_unmark_busy:
2840 * @application: a #GApplication
2841 *
2842 * Decreases the busy count of @application.
2843 *
2844 * When the busy count reaches zero, the new state will be propagated
2845 * to other processes.
2846 *
2847 * This function must only be called to cancel the effect of a previous
2848 * call to g_application_mark_busy().
2849 *
2850 * Since: 2.38
2851 **/
2852void
2853g_application_unmark_busy (GApplication *application)
2854{
2855 g_return_if_fail (G_IS_APPLICATION (application));
2856 g_return_if_fail (application->priv->busy_count > 0);
2857
2858 application->priv->busy_count--;
2859
2860 if (application->priv->busy_count == 0)
2861 {
2862 g_application_impl_set_busy_state (impl: application->priv->impl, FALSE);
2863 g_object_notify (G_OBJECT (application), property_name: "is-busy");
2864 }
2865}
2866
2867/**
2868 * g_application_get_is_busy:
2869 * @application: a #GApplication
2870 *
2871 * Gets the application's current busy state, as set through
2872 * g_application_mark_busy() or g_application_bind_busy_property().
2873 *
2874 * Returns: %TRUE if @application is currently marked as busy
2875 *
2876 * Since: 2.44
2877 */
2878gboolean
2879g_application_get_is_busy (GApplication *application)
2880{
2881 g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
2882
2883 return application->priv->busy_count > 0;
2884}
2885
2886/* Notifications {{{1 */
2887
2888/**
2889 * g_application_send_notification:
2890 * @application: a #GApplication
2891 * @id: (nullable): id of the notification, or %NULL
2892 * @notification: the #GNotification to send
2893 *
2894 * Sends a notification on behalf of @application to the desktop shell.
2895 * There is no guarantee that the notification is displayed immediately,
2896 * or even at all.
2897 *
2898 * Notifications may persist after the application exits. It will be
2899 * D-Bus-activated when the notification or one of its actions is
2900 * activated.
2901 *
2902 * Modifying @notification after this call has no effect. However, the
2903 * object can be reused for a later call to this function.
2904 *
2905 * @id may be any string that uniquely identifies the event for the
2906 * application. It does not need to be in any special format. For
2907 * example, "new-message" might be appropriate for a notification about
2908 * new messages.
2909 *
2910 * If a previous notification was sent with the same @id, it will be
2911 * replaced with @notification and shown again as if it was a new
2912 * notification. This works even for notifications sent from a previous
2913 * execution of the application, as long as @id is the same string.
2914 *
2915 * @id may be %NULL, but it is impossible to replace or withdraw
2916 * notifications without an id.
2917 *
2918 * If @notification is no longer relevant, it can be withdrawn with
2919 * g_application_withdraw_notification().
2920 *
2921 * Since: 2.40
2922 */
2923void
2924g_application_send_notification (GApplication *application,
2925 const gchar *id,
2926 GNotification *notification)
2927{
2928 gchar *generated_id = NULL;
2929
2930 g_return_if_fail (G_IS_APPLICATION (application));
2931 g_return_if_fail (G_IS_NOTIFICATION (notification));
2932 g_return_if_fail (g_application_get_is_registered (application));
2933 g_return_if_fail (!g_application_get_is_remote (application));
2934
2935 if (application->priv->notifications == NULL)
2936 application->priv->notifications = g_notification_backend_new_default (application);
2937
2938 if (id == NULL)
2939 {
2940 generated_id = g_dbus_generate_guid ();
2941 id = generated_id;
2942 }
2943
2944 g_notification_backend_send_notification (backend: application->priv->notifications, id, notification);
2945
2946 g_free (mem: generated_id);
2947}
2948
2949/**
2950 * g_application_withdraw_notification:
2951 * @application: a #GApplication
2952 * @id: id of a previously sent notification
2953 *
2954 * Withdraws a notification that was sent with
2955 * g_application_send_notification().
2956 *
2957 * This call does nothing if a notification with @id doesn't exist or
2958 * the notification was never sent.
2959 *
2960 * This function works even for notifications sent in previous
2961 * executions of this application, as long @id is the same as it was for
2962 * the sent notification.
2963 *
2964 * Note that notifications are dismissed when the user clicks on one
2965 * of the buttons in a notification or triggers its default action, so
2966 * there is no need to explicitly withdraw the notification in that case.
2967 *
2968 * Since: 2.40
2969 */
2970void
2971g_application_withdraw_notification (GApplication *application,
2972 const gchar *id)
2973{
2974 g_return_if_fail (G_IS_APPLICATION (application));
2975 g_return_if_fail (id != NULL);
2976
2977 if (application->priv->notifications == NULL)
2978 application->priv->notifications = g_notification_backend_new_default (application);
2979
2980 g_notification_backend_withdraw_notification (backend: application->priv->notifications, id);
2981}
2982
2983/* Busy binding {{{1 */
2984
2985typedef struct
2986{
2987 GApplication *app;
2988 gboolean is_busy;
2989} GApplicationBusyBinding;
2990
2991static void
2992g_application_busy_binding_destroy (gpointer data,
2993 GClosure *closure)
2994{
2995 GApplicationBusyBinding *binding = data;
2996
2997 if (binding->is_busy)
2998 g_application_unmark_busy (application: binding->app);
2999
3000 g_object_unref (object: binding->app);
3001 g_slice_free (GApplicationBusyBinding, binding);
3002}
3003
3004static void
3005g_application_notify_busy_binding (GObject *object,
3006 GParamSpec *pspec,
3007 gpointer user_data)
3008{
3009 GApplicationBusyBinding *binding = user_data;
3010 gboolean is_busy;
3011
3012 g_object_get (object, first_property_name: pspec->name, &is_busy, NULL);
3013
3014 if (is_busy && !binding->is_busy)
3015 g_application_mark_busy (application: binding->app);
3016 else if (!is_busy && binding->is_busy)
3017 g_application_unmark_busy (application: binding->app);
3018
3019 binding->is_busy = is_busy;
3020}
3021
3022/**
3023 * g_application_bind_busy_property:
3024 * @application: a #GApplication
3025 * @object: (type GObject.Object): a #GObject
3026 * @property: the name of a boolean property of @object
3027 *
3028 * Marks @application as busy (see g_application_mark_busy()) while
3029 * @property on @object is %TRUE.
3030 *
3031 * The binding holds a reference to @application while it is active, but
3032 * not to @object. Instead, the binding is destroyed when @object is
3033 * finalized.
3034 *
3035 * Since: 2.44
3036 */
3037void
3038g_application_bind_busy_property (GApplication *application,
3039 gpointer object,
3040 const gchar *property)
3041{
3042 guint notify_id;
3043 GQuark property_quark;
3044 GParamSpec *pspec;
3045 GApplicationBusyBinding *binding;
3046 GClosure *closure;
3047
3048 g_return_if_fail (G_IS_APPLICATION (application));
3049 g_return_if_fail (G_IS_OBJECT (object));
3050 g_return_if_fail (property != NULL);
3051
3052 notify_id = g_signal_lookup (name: "notify", G_TYPE_OBJECT);
3053 property_quark = g_quark_from_string (string: property);
3054 pspec = g_object_class_find_property (G_OBJECT_GET_CLASS (object), property_name: property);
3055
3056 g_return_if_fail (pspec != NULL && pspec->value_type == G_TYPE_BOOLEAN);
3057
3058 if (g_signal_handler_find (instance: object, mask: G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
3059 signal_id: notify_id, detail: property_quark, NULL, func: g_application_notify_busy_binding, NULL) > 0)
3060 {
3061 g_critical ("%s: '%s' is already bound to the busy state of the application", G_STRFUNC, property);
3062 return;
3063 }
3064
3065 binding = g_slice_new (GApplicationBusyBinding);
3066 binding->app = g_object_ref (application);
3067 binding->is_busy = FALSE;
3068
3069 closure = g_cclosure_new (G_CALLBACK (g_application_notify_busy_binding), user_data: binding,
3070 destroy_data: g_application_busy_binding_destroy);
3071 g_signal_connect_closure_by_id (instance: object, signal_id: notify_id, detail: property_quark, closure, FALSE);
3072
3073 /* fetch the initial value */
3074 g_application_notify_busy_binding (object, pspec, user_data: binding);
3075}
3076
3077/**
3078 * g_application_unbind_busy_property:
3079 * @application: a #GApplication
3080 * @object: (type GObject.Object): a #GObject
3081 * @property: the name of a boolean property of @object
3082 *
3083 * Destroys a binding between @property and the busy state of
3084 * @application that was previously created with
3085 * g_application_bind_busy_property().
3086 *
3087 * Since: 2.44
3088 */
3089void
3090g_application_unbind_busy_property (GApplication *application,
3091 gpointer object,
3092 const gchar *property)
3093{
3094 guint notify_id;
3095 GQuark property_quark;
3096 gulong handler_id;
3097
3098 g_return_if_fail (G_IS_APPLICATION (application));
3099 g_return_if_fail (G_IS_OBJECT (object));
3100 g_return_if_fail (property != NULL);
3101
3102 notify_id = g_signal_lookup (name: "notify", G_TYPE_OBJECT);
3103 property_quark = g_quark_from_string (string: property);
3104
3105 handler_id = g_signal_handler_find (instance: object, mask: G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_FUNC,
3106 signal_id: notify_id, detail: property_quark, NULL, func: g_application_notify_busy_binding, NULL);
3107 if (handler_id == 0)
3108 {
3109 g_critical ("%s: '%s' is not bound to the busy state of the application", G_STRFUNC, property);
3110 return;
3111 }
3112
3113 g_signal_handler_disconnect (instance: object, handler_id);
3114}
3115
3116/* Epilogue {{{1 */
3117/* vim:set foldmethod=marker: */
3118

source code of gtk/subprojects/glib/gio/gapplication.c