Coverage Report

Created: 2025-07-12 07:23

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