[docs] GApplication is available since Gio 2.26
[platform/upstream/glib.git] / gio / gapplication.c
1 /* GIO - GLib Input, Output and Streaming Library
2  *
3  * Copyright © 2010 Red Hat, Inc
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General
16  * Public License along with this library; if not, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Authors: Colin Walters <walters@verbum.org>
21  *          Emmanuele Bassi <ebassi@linux.intel.com>
22  */
23
24 #include "config.h"
25
26 #include <string.h>
27 #include <stdlib.h>
28
29 #include <gobject/gvaluecollector.h>
30
31 #include "gapplication.h"
32 #include "gio-marshal.h"
33 #include "glibintl.h"
34
35 #include "gioerror.h"
36
37 #include "gdbusconnection.h"
38 #include "gdbusintrospection.h"
39 #include "gdbusmethodinvocation.h"
40
41 #include "gioalias.h"
42
43 /**
44  * SECTION: gapplication
45  * @title: GApplication
46  * @short_description: Core application class
47  *
48  * A #GApplication is the foundation of an application, unique for
49  * a given application identifier.  The #GApplication wraps some
50  * low-level platform-specific services; it's expected that most
51  * software will use a higher-level application class such as
52  * #GtkApplication or #MxApplication.
53  *
54  * In addition to single-instance-ness, #GApplication provides support
55  * for 'actions', which can be presented to the user in a platform-specific
56  * way (e.g. Windows 7 jump lists). Note that these are just simple actions
57  * without parameters. For more flexible scriptability, implementing a
58  * a separate D-Bus interface is recommended, see e.g.
59  * <xref linkend="gdbus-convenience"/>.
60  *
61  * Before using #GApplication, you must choose an "application identifier".
62  * The expected form of an application identifier is very close to that of
63  * of a <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
64  * Examples include: "com.example.MyApp" "org.example.internal-apps.Calculator"
65  * For convenience, the restrictions on application identifiers are reproduced
66  * here:
67  * <itemizedlist>
68  *   <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-" and must not begin with a digit.</listitem>
69  *   <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least two elements).</listitem>
70  *   <listitem>Application identifiers must not begin with a '.' (period) character.</listitem>
71  *   <listitem>Application identifiers must not exceed 255 characters.</listitem>
72  * </itemizedlist>
73  *
74  * <refsect2><title>D-Bus implementation</title>
75  * <para>
76  * On UNIX systems using D-Bus, #GApplication is implemented by claiming the
77  * application identifier as a bus name on the session bus. The implementation
78  * exports an object at the object path that is created by replacing '.' with
79  * '/' in the application identifier (e.g. the object path for the
80  * application id 'org.gtk.TestApp' is '/org/gtk/TestApp'). The object
81  * implements the org.gtk.Application interface.
82  * </para>
83  * <classsynopsis class="interface">
84  *   <ooclass><interfacename>org.gtk.Application</interfacename></ooclass>
85  *   <methodsynopsis>
86  *     <void/>
87  *     <methodname>Activate</methodname>
88  *     <methodparam><modifier>in</modifier><type>aay</type><parameter>arguments</parameter></methodparam>
89  *     <methodparam><modifier>in</modifier><type>a{sv}</type><parameter>data</parameter></methodparam>
90  *   </methodsynopsis>
91  *   <methodsynopsis>
92  *     <void/>
93  *     <methodname>InvokeAction</methodname>
94  *     <methodparam><modifier>in</modifier><type>s</type><parameter>action</parameter></methodparam>
95  *     <methodparam><modifier>in</modifier><type>u</type><parameter>timestamp</parameter></methodparam>
96  *   </methodsynopsis>
97  *   <methodsynopsis>
98  *     <type>a{s(sb)}</type>
99  *     <methodname>ListActions</methodname>
100  *     <void/>
101  *   </methodsynopsis>
102  *   <methodsynopsis>
103  *     <void/>
104  *     <methodname>Quit</methodname>
105  *     <methodparam><modifier>in</modifier><type>u</type><parameter>timestamp</parameter></methodparam>
106  *   </methodsynopsis>
107  *   <methodsynopsis>
108  *     <modifier>Signal</modifier>
109  *     <void/>
110  *     <methodname>ActionsChanged</methodname>
111  *     <void/>
112  *   </methodsynopsis>
113  * </classsynopsis>
114  * <para>
115  * The <methodname>Activate</methodname> function is called on the existing
116  * application instance when a second instance fails to take the bus name.
117  * @arguments contains the commandline arguments given to the second instance
118  * and @data contains platform-specific additional data, see
119  * g_application_format_activation_data().
120  * </para>
121  * <para>
122  * The <methodname>InvokeAction</methodname> function can be called to invoke
123  * one of the actions exported by the application. The @timestamp parameter
124  * should be taken from the user event that triggered the method call (e.g.
125  * a button press event).
126  * </para>
127  * <para>
128  * The <methodname>ListActions</methodname> function returns a dictionary
129  * with the exported actions of the application. The keys of the dictionary
130  * are the action names, and the values are structs containing the description
131  * for the action and a boolean that represents if the action is enabled or not.
132  * </para>
133  * <para>
134  * The <methodname>Quit</methodname> function can be called to terminate
135  * the application. The @timestamp parameter should be taken from the user
136  * event that triggered the method call (e.g. a button press event).
137  * </para>
138  * <para>
139  * The <methodname>ActionsChanged</methodname> signal is emitted when the
140  * exported actions change (i.e. an action is added, removed, enabled,
141  * disabled, or otherwise changed).
142  * </para>
143  * <para>
144  * #GApplication is supported since Gio 2.26.
145  * </para>
146  * </refsect2>
147  */
148
149 G_DEFINE_TYPE (GApplication, g_application, G_TYPE_OBJECT);
150
151 enum
152 {
153   PROP_0,
154
155   PROP_APPID,
156   PROP_DEFAULT_QUIT,
157   PROP_IS_REMOTE
158 };
159
160 enum
161 {
162   QUIT,
163   ACTION,
164   PREPARE_ACTIVATION,
165
166   LAST_SIGNAL
167 };
168
169 static guint application_signals[LAST_SIGNAL] = { 0 };
170
171 typedef struct {
172   gchar *name;
173   gchar *description;
174   guint enabled : 1;
175 } GApplicationAction;
176
177 struct _GApplicationPrivate
178 {
179   gchar *appid;
180   GHashTable *actions; /* name -> GApplicationAction */
181   GMainLoop *mainloop;
182
183   guint default_quit : 1;
184   guint is_remote    : 1;
185
186   guint actions_changed_id;
187
188 #ifdef G_OS_UNIX
189   gchar *dbus_path;
190   GDBusConnection *session_bus;
191 #endif
192 };
193
194 static GApplication *primary_application = NULL;
195 static GHashTable *instances_for_appid = NULL;
196
197 static void     _g_application_platform_init                    (GApplication  *app); 
198 static gboolean _g_application_platform_acquire_single_instance (GApplication  *app,
199                                                                  GError       **error);
200 static void     _g_application_platform_remote_invoke_action    (GApplication  *app,
201                                                                  const gchar   *action,
202                                                                  guint          timestamp);
203 static void     _g_application_platform_remote_quit             (GApplication  *app,
204                                                                  guint          timestamp);
205 static void     _g_application_platform_activate                (GApplication  *app,
206                                                                  GVariant      *data) G_GNUC_NORETURN;
207 static void     _g_application_platform_on_actions_changed      (GApplication  *app);
208
209 #ifdef G_OS_UNIX
210 #include "gdbusapplication.c"
211 #else
212 #include "gnullapplication.c"
213 #endif
214
215 static gboolean
216 _g_application_validate_id (const char *id)
217 {
218   gboolean allow_dot;
219
220   if (strlen (id) > 255)
221     return FALSE;
222
223   if (!g_ascii_isalpha (*id))
224     return FALSE;
225
226   id++;
227   allow_dot = FALSE;
228   for (; *id; id++)
229     {
230       if (g_ascii_isalnum (*id) || (*id == '-') || (*id == '_'))
231         allow_dot = TRUE;
232       else if (allow_dot && *id == '.')
233         allow_dot = FALSE;
234       else
235         return FALSE;
236     }
237   return TRUE;
238 }
239
240 static gpointer
241 init_appid_statics (gpointer data)
242 {
243   instances_for_appid = g_hash_table_new (g_str_hash, g_str_equal);
244   return NULL;
245 }
246
247 static GApplication *
248 application_for_appid (const char *appid)
249 {
250   static GOnce appid_once = G_ONCE_INIT;
251
252   g_once (&appid_once, init_appid_statics, NULL);
253
254   return g_hash_table_lookup (instances_for_appid, appid);
255 }
256
257 static gboolean
258 g_application_default_quit (GApplication *application,
259                             guint         timestamp)
260 {
261   g_return_val_if_fail (application->priv->mainloop != NULL, FALSE);
262   g_main_loop_quit (application->priv->mainloop);
263
264   return TRUE;
265 }
266
267 static void
268 g_application_default_run (GApplication *application)
269 {
270   if (application->priv->mainloop == NULL)
271     application->priv->mainloop = g_main_loop_new (NULL, TRUE);
272
273   g_main_loop_run (application->priv->mainloop);
274 }
275
276 static void
277 _g_application_handle_activation (GApplication  *app,
278                                   int            argc,
279                                   char         **argv,
280                                   GVariant      *platform_data)
281 {
282   GVariantBuilder builder;
283   GVariant *message;
284   int i;
285
286   g_variant_builder_init (&builder, G_VARIANT_TYPE ("(aaya{sv})"));
287   g_variant_builder_open (&builder, G_VARIANT_TYPE ("aay"));
288
289   for (i = 1; i < argc; i++)
290     {
291       int j;
292       guint8 *argv_bytes;
293
294       g_variant_builder_open (&builder, G_VARIANT_TYPE ("ay"));
295
296       argv_bytes = (guint8*) argv[i];
297       for (j = 0; argv_bytes[j]; j++)
298         g_variant_builder_add_value (&builder,
299                                      g_variant_new_byte (argv_bytes[j]));
300       g_variant_builder_close (&builder);
301     }
302   g_variant_builder_close (&builder);
303
304   if (platform_data)
305     g_variant_builder_add (&builder, "@a{sv}", platform_data);
306   else
307     {
308       g_variant_builder_open (&builder, G_VARIANT_TYPE ("a{sv}"));
309       g_variant_builder_close (&builder);
310     }
311
312   message = g_variant_builder_end (&builder);
313   _g_application_platform_activate (app, message);
314   g_variant_unref (message);
315 }
316
317 static gboolean
318 timeout_handle_actions_changed (gpointer user_data)
319 {
320   GApplication *application = user_data;
321
322   application->priv->actions_changed_id = 0;
323
324   _g_application_platform_on_actions_changed (application);
325
326   return FALSE;
327 }
328
329 static inline void
330 queue_actions_change_notification (GApplication *application)
331 {
332   GApplicationPrivate *priv = application->priv;
333
334   if (priv->actions_changed_id == 0)
335     priv->actions_changed_id = g_timeout_add (0, timeout_handle_actions_changed, application);
336 }
337
338 static void
339 g_application_action_free (gpointer data)
340 {
341   if (G_LIKELY (data != NULL))
342     {
343       GApplicationAction *action = data;
344
345       g_free (action->name);
346       g_free (action->description);
347
348       g_slice_free (GApplicationAction, action);
349     }
350 }
351
352
353 /**
354  * g_application_new:
355  * @appid: System-dependent application identifier
356  *
357  * Create a new #GApplication.  The application is initially in
358  * "remote" mode.  Almost certainly, you want to call
359  * g_application_register() immediately after this function, which
360  * will finish initialization.
361  *
362  * As a convenience, this function is defined to call g_type_init() as
363  * its very first action.
364  *
365  * Returns: (transfer full): An application instance
366  *
367  * Since: 2.26
368  */
369 GApplication *
370 g_application_new (const gchar *appid)
371 {
372   g_type_init ();
373
374   return G_APPLICATION (g_object_new (G_TYPE_APPLICATION, "appid", appid, NULL));
375 }
376
377 /**
378  * g_application_register:
379  * @application: A #GApplication
380  * @argc: System argument count
381  * @argv: (array length=argc): System argument vector
382  * @platform_data: (allow-none): Arbitrary platform-specific data, must have signature "a{sv}"
383  *
384  * Ensure the current process is the unique owner of the application.
385  * If successful, the #GApplication:is-remote property will be changed
386  * to %FALSE, and it is safe to continue creating other resources
387  * such as graphics windows.
388  *
389  * If the given @appid is already running in another process, the
390  * #GApplication:default-exit property will be evaluated.  If it's
391  * %TRUE, then a platform-specific action such as bringing any
392  * graphics windows associated with the application to the foreground
393  * may be initiated.  After that, the current process will terminate.
394  * If %FALSE, then the application remains in the #GApplication:is-remote
395  * state, and you can e.g. call g_application_invoke_action().
396  */
397 void
398 g_application_register_with_data (GApplication  *application,
399                                   gint           argc,
400                                   gchar        **argv,
401                                   GVariant      *platform_data)
402 {
403   g_return_if_fail (application->priv->appid != NULL);
404   g_return_if_fail (application->priv->is_remote);
405   g_return_if_fail (platform_data == NULL
406                     || strcmp (g_variant_get_type_string (platform_data), "a{sv}") == 0);
407
408   if (!_g_application_platform_acquire_single_instance (application, NULL))
409     {
410       if (application->priv->default_quit)
411         _g_application_handle_activation (application, argc, argv, platform_data);
412       else
413         return;
414     }
415
416   application->priv->is_remote = FALSE;
417
418   _g_application_platform_init (application);
419 }
420
421 /**
422  * g_application_new_and_register:
423  * @appid: An application identifier
424  * @argc: System argument count
425  * @argv: (array length=argc): System argument vector
426  *
427  * This is a convenience function which combines g_application_new()
428  * with g_application_register_with_data().
429  */
430 GApplication *
431 g_application_new_and_register (const gchar  *appid,
432                                 gint          argc,
433                                 gchar       **argv)
434 {
435   GApplication *app = g_application_new (appid);
436   g_application_register_with_data (app, argc, argv, NULL);
437   return app;
438 }
439
440 /**
441  * g_application_add_action:
442  * @application: a #GApplication
443  * @name: the action name
444  * @description: the action description; can be a translatable
445  *   string
446  *
447  * Adds an action @name to the list of exported actions of @application.
448  *
449  * It is an error to call this function if @application is a proxy for
450  * a remote application.
451  *
452  * You can invoke an action using g_application_invoke_action().
453  *
454  * The newly added action is enabled by default; you can call
455  * g_application_set_action_enabled() to disable it.
456  *
457  * Since: 2.26
458  */
459 void
460 g_application_add_action (GApplication *application,
461                           const gchar  *name,
462                           const gchar  *description)
463 {
464   GApplicationPrivate *priv;
465   GApplicationAction *action;
466
467   g_return_if_fail (G_IS_APPLICATION (application));
468   g_return_if_fail (name != NULL && *name != '\0');
469   g_return_if_fail (!application->priv->is_remote);
470
471   priv = application->priv;
472
473   g_return_if_fail (g_hash_table_lookup (priv->actions, name) == NULL);
474
475   action = g_slice_new (GApplicationAction);
476   action->name = g_strdup (name);
477   action->description = g_strdup (description);
478   action->enabled = TRUE;
479
480   g_hash_table_insert (priv->actions, action->name, action);
481   queue_actions_change_notification (application);
482 }
483
484 /**
485  * g_application_remove_action:
486  * @application: a #GApplication
487  * @name: the name of the action to remove
488  *
489  * Removes the action @name from the list of exported actions of @application.
490  *
491  * It is an error to call this function if @application is a proxy for
492  * a remote application.
493  *
494  * Since: 2.26
495  */
496 void
497 g_application_remove_action (GApplication *application,
498                              const gchar  *name)
499 {
500   GApplicationPrivate *priv;
501
502   g_return_if_fail (G_IS_APPLICATION (application));
503   g_return_if_fail (name != NULL && *name != '\0');
504   g_return_if_fail (!application->priv->is_remote);
505
506   priv = application->priv;
507
508   g_return_if_fail (g_hash_table_lookup (priv->actions, name) != NULL);
509
510   g_hash_table_remove (priv->actions, name);
511   queue_actions_change_notification (application);
512 }
513
514 /**
515  * g_application_invoke_action:
516  * @application: a #GApplication
517  * @name: the name of the action to invoke
518  * @timestamp: the timestamp that is going to be passed to
519  *   the #GApplication::action signal
520  *
521  * Invokes the action @name of the passed #GApplication.
522  *
523  * This function has different behavior depending on whether @application
524  * is acting as a proxy for another process.  In the normal case where
525  * the current process is hosting the application, and the specified
526  * action exists and is enabled, the #GApplication::action signal will
527  * be emitted.
528  *
529  * If @application is a proxy, then the specified action will be invoked
530  * in the remote process. It is not necessary to call
531  * g_application_add_action() in the current process in order to invoke
532  * one remotely.
533  *
534  * Since: 2.26
535  */
536 void
537 g_application_invoke_action (GApplication *application,
538                              const gchar  *name,
539                              guint         timestamp)
540 {
541   GApplicationPrivate *priv;
542   GApplicationAction *action;
543
544   g_return_if_fail (G_IS_APPLICATION (application));
545   g_return_if_fail (name != NULL);
546
547   priv = application->priv;
548
549   if (priv->is_remote)
550     {
551       _g_application_platform_remote_invoke_action (application, name, timestamp);
552       return;
553     }
554
555   action = g_hash_table_lookup (priv->actions, name);
556   g_return_if_fail (action != NULL);
557   if (!action->enabled)
558     return;
559
560   g_signal_emit (application, application_signals[ACTION],
561                  g_quark_from_string (name),
562                  name,
563                  timestamp);
564 }
565
566 /**
567  * g_application_list_actions:
568  * @application: a #GApplication
569  *
570  * Retrieves the list of action names currently exported by @application.
571  *
572  * It is an error to call this function if @application is a proxy for
573  * a remote application.
574  *
575  * Return value: (transfer full): a newly allocation, %NULL-terminated array
576  *   of strings containing action names; use g_strfreev() to free the
577  *   resources used by the returned array
578  *
579  * Since: 2.26
580  */
581 gchar **
582 g_application_list_actions (GApplication *application)
583 {
584   GApplicationPrivate *priv;
585   GHashTableIter iter;
586   gpointer key;
587   gchar **retval;
588   gint i;
589
590   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
591   g_return_val_if_fail (!application->priv->is_remote, NULL);
592
593   priv = application->priv;
594
595   retval = g_new (gchar*, g_hash_table_size (priv->actions));
596
597   i = 0;
598   g_hash_table_iter_init (&iter, priv->actions);
599   while (g_hash_table_iter_next (&iter, &key, NULL))
600     retval[i++] = g_strdup (key);
601
602   retval[i] = NULL;
603
604   return retval;
605 }
606
607 /**
608  * g_application_set_action_enabled:
609  * @application: a #GApplication
610  * @name: the name of the application
611  * @enabled: whether to enable or disable the action @name
612  *
613  * Sets whether the action @name inside @application should be enabled
614  * or disabled.
615  *
616  * It is an error to call this function if @application is a proxy for
617  * a remote application.
618  *
619  * Invoking a disabled action will not result in the #GApplication::action
620  * signal being emitted.
621  *
622  * Since: 2.26
623  */
624 void
625 g_application_set_action_enabled (GApplication *application,
626                                   const gchar  *name,
627                                   gboolean      enabled)
628 {
629   GApplicationAction *action;
630
631   g_return_if_fail (G_IS_APPLICATION (application));
632   g_return_if_fail (name != NULL);
633   g_return_if_fail (!application->priv->is_remote);
634
635   enabled = !!enabled;
636
637   action = g_hash_table_lookup (application->priv->actions, name);
638   g_return_if_fail (action != NULL);
639   if (action->enabled == enabled)
640     return;
641
642   action->enabled = enabled;
643
644   queue_actions_change_notification (application);
645 }
646
647
648 /**
649  * g_application_get_action_description:
650  * @application: a #GApplication
651  * @name: Action name
652  *
653  * Gets the description of the action @name.
654  *
655  * It is an error to call this function if @application is a proxy for
656  * a remote application.
657  *
658  * Returns: Description for the given action named @name
659  *
660  * Since: 2.26
661  */
662 G_CONST_RETURN gchar *
663 g_application_get_action_description (GApplication *application,
664                                       const gchar  *name)
665 {
666   GApplicationAction *action;
667   
668   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
669   g_return_val_if_fail (name != NULL, NULL);
670   g_return_val_if_fail (!application->priv->is_remote, NULL);
671
672   action = g_hash_table_lookup (application->priv->actions, name);
673   g_return_val_if_fail (action != NULL, NULL);
674
675   return action->description;
676 }
677
678
679 /**
680  * g_application_get_action_enabled:
681  * @application: a #GApplication
682  * @name: the name of the action
683  *
684  * Retrieves whether the action @name is enabled or not.
685  *
686  * See g_application_set_action_enabled().
687  *
688  * It is an error to call this function if @application is a proxy for
689  * a remote application.
690  *
691  * Return value: %TRUE if the action was enabled, and %FALSE otherwise
692  *
693  * Since: 2.26
694  */
695 gboolean
696 g_application_get_action_enabled (GApplication *application,
697                                   const gchar  *name)
698 {
699   GApplicationAction *action;
700
701   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
702   g_return_val_if_fail (name != NULL, FALSE);
703   g_return_val_if_fail (!application->priv->is_remote, FALSE);
704
705   action = g_hash_table_lookup (application->priv->actions, name);
706   g_return_val_if_fail (action != NULL, FALSE);
707
708   return action->enabled;
709 }
710
711 /**
712  * g_application_run:
713  * @application: a #GApplication
714  *
715  * Starts the application.
716  *
717  * The default implementation of this virtual function will simply run
718  * a main loop.
719  *
720  * It is an error to call this function if @application is a proxy for
721  * a remote application.
722  *
723  * Since: 2.26
724  */
725 void
726 g_application_run (GApplication *application)
727 {
728   g_return_if_fail (G_IS_APPLICATION (application));
729   g_return_if_fail (!application->priv->is_remote);
730
731   G_APPLICATION_GET_CLASS (application)->run (application);
732 }
733
734 /**
735  * g_application_quit:
736  * @application: a #GApplication
737  * @timestamp: Platform-specific event timestamp, may be 0 for default
738  *
739  * Request that the application quits.
740  *
741  * This function has different behavior depending on whether @application
742  * is acting as a proxy for another process.  In the normal case where
743  * the current process is hosting the application, the default
744  * implementation will quit the main loop created by g_application_run().
745  *
746  * If @application is a proxy, then the remote process will be asked
747  * to quit.
748  *
749  * Returns: %TRUE if the application accepted the request, %FALSE otherwise
750  *
751  * Since: 2.26
752  */
753 gboolean
754 g_application_quit (GApplication *application,
755                     guint         timestamp)
756 {
757   gboolean retval = FALSE;
758
759   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
760
761   if (application->priv->is_remote)
762     {
763        _g_application_platform_remote_quit (application, timestamp);
764        retval = TRUE;
765     }
766   else
767     g_signal_emit (application, application_signals[QUIT], 0, timestamp, &retval);
768
769   return retval;
770 }
771
772 /**
773  * g_application_get_instance:
774  *
775  * In the normal case where there is exactly one #GApplication instance
776  * in this process, return that instance.  If there are multiple, the
777  * first one created will be returned.  Otherwise, return %NULL.
778  *
779  * Returns: (transfer none): The primary instance of #GApplication,
780  *   or %NULL if none is set
781  *
782  * Since: 2.26
783  */
784 GApplication *
785 g_application_get_instance (void)
786 {
787   return primary_application;
788 }
789
790 /**
791  * g_application_get_id:
792  *
793  * Retrieves the platform-specific identifier for the #GApplication.
794  *
795  * Return value: The platform-specific identifier. The returned string
796  *   is owned by the #GApplication instance and it should never be
797  *   modified or freed
798  *
799  * Since: 2.26
800  */
801 G_CONST_RETURN gchar *
802 g_application_get_id (GApplication *application)
803 {
804   g_return_val_if_fail (G_IS_APPLICATION (application), NULL);
805
806   return application->priv->appid;
807 }
808
809 /**
810  * g_application_is_remote:
811  * @application: a #GApplication
812  *
813  * Returns: %TRUE if this object represents a proxy for a remote application.
814  */
815 gboolean
816 g_application_is_remote (GApplication *application)
817 {
818   g_return_val_if_fail (G_IS_APPLICATION (application), FALSE);
819
820   return application->priv->is_remote;
821 }
822
823 static void
824 g_application_init (GApplication *app)
825 {
826   app->priv = G_TYPE_INSTANCE_GET_PRIVATE (app,
827                                            G_TYPE_APPLICATION,
828                                            GApplicationPrivate);
829
830   app->priv->actions = g_hash_table_new_full (g_str_hash, g_str_equal,
831                                               NULL,
832                                               g_application_action_free);
833   app->priv->default_quit = TRUE;
834   app->priv->is_remote = TRUE;
835 }
836
837 static void
838 g_application_get_property (GObject    *object,
839                             guint       prop_id,
840                             GValue     *value,
841                             GParamSpec *pspec)
842 {
843   GApplication *app = G_APPLICATION (object);
844
845   switch (prop_id)
846     {
847     case PROP_APPID:
848       g_value_set_string (value, g_application_get_id (app));
849       break;
850
851     case PROP_DEFAULT_QUIT:
852       g_value_set_boolean (value, app->priv->default_quit);
853       break;
854
855     case PROP_IS_REMOTE:
856       g_value_set_boolean (value, g_application_is_remote (app));
857       break;
858
859     default:
860       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
861     }
862 }
863
864 static void
865 g_application_set_property (GObject      *object,
866                             guint         prop_id,
867                             const GValue *value,
868                             GParamSpec   *pspec)
869 {
870   GApplication *app = G_APPLICATION (object);
871
872   switch (prop_id)
873     {
874     case PROP_APPID:
875       g_return_if_fail (_g_application_validate_id (g_value_get_string (value)));
876       app->priv->appid = g_value_dup_string (value);
877       break;
878
879     case PROP_DEFAULT_QUIT:
880       app->priv->default_quit = g_value_get_boolean (value);
881       break;
882
883     default:
884       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
885     }
886 }
887
888 static GObject*
889 g_application_constructor (GType                  type,
890                            guint                  n_construct_properties,
891                            GObjectConstructParam *construct_params)
892 {
893   GApplication *app;
894   GObject *object;
895   const char *appid = NULL;
896   guint i;
897
898   for (i = 0; i < n_construct_properties; i++)
899     {
900       GObjectConstructParam *param = &construct_params[i];
901       if (strcmp (param->pspec->name, "appid") == 0)
902         appid = g_value_get_string (param->value);
903     }
904
905   g_return_val_if_fail (appid != NULL, NULL);
906
907   app = application_for_appid (appid);
908   if (app != NULL)
909     return g_object_ref (app);
910
911   object = (* G_OBJECT_CLASS (g_application_parent_class)->constructor) (type,
912                                                                          n_construct_properties,
913                                                                          construct_params);
914   app = G_APPLICATION (object);
915
916   if (primary_application == NULL)
917     primary_application = app;
918   g_hash_table_insert (instances_for_appid, g_strdup (appid), app);
919
920   return object;
921 }
922
923 static void
924 g_application_finalize (GObject *object)
925 {
926   GApplication *app = G_APPLICATION (object);
927
928   g_free (app->priv->appid);
929   if (app->priv->actions)
930     g_hash_table_unref (app->priv->actions);
931   if (app->priv->actions_changed_id)
932     g_source_remove (app->priv->actions_changed_id);
933   if (app->priv->mainloop)
934     g_main_loop_unref (app->priv->mainloop);
935
936 #ifdef G_OS_UNIX
937   g_free (app->priv->dbus_path);
938   if (app->priv->session_bus)
939     g_object_unref (app->priv->session_bus);
940 #endif
941
942   G_OBJECT_CLASS (g_application_parent_class)->finalize (object);
943 }
944
945 static void
946 g_application_class_init (GApplicationClass *klass)
947 {
948   GObjectClass *gobject_class G_GNUC_UNUSED = G_OBJECT_CLASS (klass);
949
950   g_type_class_add_private (klass, sizeof (GApplicationPrivate));
951
952   gobject_class->constructor = g_application_constructor;
953   gobject_class->set_property = g_application_set_property;
954   gobject_class->get_property = g_application_get_property;
955
956   gobject_class->finalize = g_application_finalize;
957
958   klass->run = g_application_default_run;
959   klass->quit = g_application_default_quit;
960
961   application_signals[QUIT] =
962     g_signal_new (g_intern_static_string ("quit"),
963                   G_OBJECT_CLASS_TYPE (klass),
964                   G_SIGNAL_RUN_LAST,
965                   G_STRUCT_OFFSET (GApplicationClass, quit),
966                   g_signal_accumulator_true_handled, NULL,
967                   _gio_marshal_BOOLEAN__UINT,
968                   G_TYPE_BOOLEAN, 1,
969                   G_TYPE_UINT);
970
971   application_signals[ACTION] =
972     g_signal_new (g_intern_static_string ("action"),
973                   G_OBJECT_CLASS_TYPE (klass),
974                   G_SIGNAL_RUN_FIRST | G_SIGNAL_NO_RECURSE | G_SIGNAL_DETAILED,
975                   G_STRUCT_OFFSET (GApplicationClass, action),
976                   NULL, NULL,
977                   _gio_marshal_VOID__STRING_INT,
978                   G_TYPE_NONE, 2,
979                   G_TYPE_STRING,
980                   G_TYPE_INT);
981
982    /**
983    * GApplication::prepare-activation:
984    * @arguments: A #GVariant with the signature "aay"
985    * @platform_data: A #GVariant with the signature "a{sv}"
986    *
987    * This signal is emitted when a non-primary process for a given
988    * application is invoked while your application is running; for
989    * example, when a file browser launches your program to open a
990    * file.  The raw operating system arguments are passed in the
991    * @arguments variant.  Additional platform-dependent data is
992    * stored in @platform_data.
993    */
994
995   application_signals[PREPARE_ACTIVATION] =
996     g_signal_new (g_intern_static_string ("prepare-activation"),
997                   G_OBJECT_CLASS_TYPE (klass),
998                   G_SIGNAL_RUN_LAST,
999                   G_STRUCT_OFFSET (GApplicationClass, prepare_activation),
1000                   NULL, NULL,
1001                   _gio_marshal_VOID__BOXED_BOXED,
1002                   G_TYPE_NONE, 2,
1003                   G_TYPE_VARIANT,
1004                   G_TYPE_VARIANT);
1005
1006    /**
1007    * GApplication:appid:
1008    *
1009    * The unique identifier for this application.  See the documentation for
1010    * #GApplication for more information about this property.
1011    *
1012    */
1013   g_object_class_install_property (gobject_class,
1014                                    PROP_APPID,
1015                                    g_param_spec_string ("appid",
1016                                                         P_("Application ID"),
1017                                                         P_("Identifier for this application"),
1018                                                         NULL,
1019                                                         G_PARAM_READWRITE |
1020                                                         G_PARAM_CONSTRUCT_ONLY |
1021                                                         G_PARAM_STATIC_STRINGS));
1022
1023   /**
1024    * GApplication:default-quit:
1025    *
1026    * By default, if a different process is running this application, the
1027    * process will be exited.  Set this property to %FALSE to allow custom
1028    * interaction with the remote process.
1029    *
1030    */
1031   g_object_class_install_property (gobject_class,
1032                                    PROP_DEFAULT_QUIT,
1033                                    g_param_spec_boolean ("default-quit",
1034                                                          P_("Default Quit"),
1035                                                          P_("Exit the process by default"),
1036                                                          TRUE,
1037                                                          G_PARAM_READWRITE |
1038                                                          G_PARAM_CONSTRUCT_ONLY |
1039                                                          G_PARAM_STATIC_STRINGS));
1040
1041
1042   /**
1043    * GApplication:is-remote:
1044    *
1045    * This property is %TRUE if this application instance represents a proxy
1046    * to the instance of this application in another process.
1047    *
1048    */
1049   g_object_class_install_property (gobject_class,
1050                                    PROP_IS_REMOTE,
1051                                    g_param_spec_boolean ("is-remote",
1052                                                          P_("Is Remote"),
1053                                                          P_("Whether this application is a proxy for another process"),
1054                                                          TRUE,
1055                                                          G_PARAM_READABLE | G_PARAM_STATIC_STRINGS));
1056 }
1057
1058 #define __G_APPLICATION_C__
1059 #include "gioaliasdef.c"