2 * Copyright © 2010 Codethink Limited
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published
6 * by the Free Software Foundation; either version 2 of the licence or (at
7 * your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General
15 * Public License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Authors: Ryan Lortie <desrt@desrt.ca>
25 #include "gapplication.h"
27 #include "gapplicationcommandline.h"
28 #include "gapplicationimpl.h"
29 #include "gactiongroup.h"
30 #include "gsettings.h"
32 #include "gioenumtypes.h"
41 * SECTION:gapplication
42 * @title: GApplication
43 * @short_description: Core application class
45 * A #GApplication is the foundation of an application, unique for a
46 * given application identifier. The GApplication class wraps some
47 * low-level platform-specific services and is intended to act as the
48 * foundation for higher-level application classes such as
49 * #GtkApplication or #MxApplication. In general, you should not use
50 * this class outside of a higher level framework.
52 * One of the core features that GApplication provides is process
53 * uniqueness, in the context of a "session". The session concept is
54 * platform-dependent, but corresponds roughly to a graphical desktop
55 * login. When your application is launched again, its arguments
56 * are passed through platform communication to the already running
57 * program. The already running instance of the program is called the
58 * <firstterm>primary instance</firstterm>.
60 * Before using GApplication, you must choose an "application identifier".
61 * The expected form of an application identifier is very close to that of
62 * of a <ulink url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-interface">DBus bus name</ulink>.
63 * Examples include: "com.example.MyApp", "org.example.internal-apps.Calculator".
64 * For details on valid application identifiers, see
65 * g_application_id_is_valid().
67 * The application identifier is claimed by the application as a
68 * well-known bus name on the user's session bus. This means that the
69 * uniqueness of your application is scoped to the current session. It
70 * also means that your application may provide additional services
71 * (through registration of other object paths) at that bus name.
73 * The registration of these object paths should be done with the shared
74 * GDBus session bus. Note that due to the internal architecture of
75 * GDBus, method calls can be dispatched at any time (even if a main
76 * loop is not running). For this reason, you must ensure that any
77 * object paths that you wish to register are registered before
78 * #GApplication attempts to acquire the bus name of your application
79 * (which happens in g_application_register()). Unfortunately, this
80 * means that you cannot use g_application_get_is_remote() to decide if
81 * you want to register object paths.
83 * GApplication provides convenient life cycle management by maintaining
84 * a <firstterm>use count</firstterm> for the primary application instance.
85 * The use count can be changed using g_application_hold() and
86 * g_application_release(). If it drops to zero, the application exits.
88 * GApplication also implements the #GActionGroup interface and lets you
89 * easily export actions by adding them with g_application_set_action_group().
90 * When invoking an action by calling g_action_group_activate_action() on
91 * the application, it is always invoked in the primary instance.
93 * There is a number of different entry points into a #GApplication:
95 * <listitem>via 'Activate' (i.e. just starting the application)</listitem>
96 * <listitem>via 'Open' (i.e. opening some files)</listitem>
97 * <listitem>by handling a command-line</listitem>
98 * <listitem>via activating an action</listitem>
100 * The #GApplication::startup signal lets you handle the application
101 * initialization for all of these in a single place.
103 * Regardless of which of these entry points is used to start the application,
104 * GApplication passes some <firstterm id="platform-data">platform
105 * data</firstterm> from the launching instance to the primary instance,
106 * in the form of a #GVariant dictionary mapping strings to variants.
107 * To use platform data, override the @before_emit or @after_emit virtual
108 * functions in your #GApplication subclass. When dealing with
109 * #GApplicationCommandline objects, the platform data is directly
110 * available via g_application_command_line_get_cwd(),
111 * g_application_command_line_get_environ() and
112 * g_application_command_line_get_platform_data().
114 * As the name indicates, the platform data may vary depending on the
115 * operating system, but it always includes the current directory (key
116 * "cwd"), and optionally the environment (ie the set of environment
117 * variables and their values) of the calling process (key "environ").
118 * The environment is only added to the platform data if the
119 * #G_APPLICATION_SEND_ENVIONMENT flag is set. GApplication subclasses
120 * can add their own platform data by overriding the @add_platform_data
121 * virtual function. For instance, #GtkApplication adds startup notification
124 * To parse commandline arguments you may handle the
125 * #GApplication::command-line signal or override the local_command_line()
126 * vfunc, to parse them in either the primary instance or the local instance,
129 * <example id="gapplication-example-open"><title>Opening files with a GApplication</title>
131 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-open.c">
132 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
137 * <example id="gapplication-example-actions"><title>A GApplication with actions</title>
139 * <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" parse="text" href="../../../../gio/tests/gapplication-example-actions.c">
140 * <xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback>
146 struct _GApplicationPrivate
148 GApplicationFlags flags
;
151 GActionGroup
*actions
;
153 guint inactivity_timeout_id
;
154 guint inactivity_timeout
;
157 guint is_registered
: 1;
159 guint did_startup
: 1;
160 guint did_shutdown
: 1;
162 GHashTable
*remote_actions
; /* string -> RemoteActionInfo */
163 GApplicationImpl
*impl
;
173 PROP_INACTIVITY_TIMEOUT
,
188 static guint g_application_signals
[NR_SIGNALS
];
190 static void g_application_action_group_iface_init (GActionGroupInterface
*);
191 G_DEFINE_TYPE_WITH_CODE (GApplication
, g_application
, G_TYPE_OBJECT
,
192 G_IMPLEMENT_INTERFACE (G_TYPE_ACTION_GROUP
,
193 g_application_action_group_iface_init
))
195 /* vfunc defaults {{{1 */
197 g_application_real_before_emit (GApplication
*application
,
198 GVariant
*platform_data
)
203 g_application_real_after_emit (GApplication
*application
,
204 GVariant
*platform_data
)
209 g_application_real_startup (GApplication
*application
)
211 application
->priv
->did_startup
= TRUE
;
215 g_application_real_shutdown (GApplication
*application
)
217 application
->priv
->did_shutdown
= TRUE
;
221 g_application_real_activate (GApplication
*application
)
223 if (!g_signal_has_handler_pending (application
,
224 g_application_signals
[SIGNAL_ACTIVATE
],
226 G_APPLICATION_GET_CLASS (application
)->activate
== g_application_real_activate
)
228 static gboolean warned
;
233 g_warning ("Your application does not implement "
234 "g_application_activate() and has no handlers connected "
235 "to the 'activate' signal. It should do one of these.");
241 g_application_real_open (GApplication
*application
,
246 if (!g_signal_has_handler_pending (application
,
247 g_application_signals
[SIGNAL_OPEN
],
249 G_APPLICATION_GET_CLASS (application
)->open
== g_application_real_open
)
251 static gboolean warned
;
256 g_warning ("Your application claims to support opening files "
257 "but does not implement g_application_open() and has no "
258 "handlers connected to the 'open' signal.");
264 g_application_real_command_line (GApplication
*application
,
265 GApplicationCommandLine
*cmdline
)
267 if (!g_signal_has_handler_pending (application
,
268 g_application_signals
[SIGNAL_COMMAND_LINE
],
270 G_APPLICATION_GET_CLASS (application
)->command_line
== g_application_real_command_line
)
272 static gboolean warned
;
277 g_warning ("Your application claims to support custom command line "
278 "handling but does not implement g_application_command_line() "
279 "and has no handlers connected to the 'command-line' signal.");
288 g_application_real_local_command_line (GApplication
*application
,
292 if (application
->priv
->flags
& G_APPLICATION_HANDLES_COMMAND_LINE
)
297 GError
*error
= NULL
;
300 if (!g_application_register (application
, NULL
, &error
))
302 g_critical ("%s", error
->message
);
303 g_error_free (error
);
308 n_args
= g_strv_length (*arguments
);
310 if (application
->priv
->flags
& G_APPLICATION_IS_SERVICE
)
312 if ((*exit_status
= n_args
> 1))
314 g_printerr ("GApplication service mode takes no arguments.\n");
315 application
->priv
->flags
&= ~G_APPLICATION_IS_SERVICE
;
323 g_application_activate (application
);
329 if (~application
->priv
->flags
& G_APPLICATION_HANDLES_OPEN
)
331 g_critical ("This application can not open files.");
340 n_files
= n_args
- 1;
341 files
= g_new (GFile
*, n_files
);
343 for (i
= 0; i
< n_files
; i
++)
344 files
[i
] = g_file_new_for_commandline_arg ((*arguments
)[i
+ 1]);
346 g_application_open (application
, files
, n_files
, "");
348 for (i
= 0; i
< n_files
; i
++)
349 g_object_unref (files
[i
]);
361 g_application_real_add_platform_data (GApplication
*application
,
362 GVariantBuilder
*builder
)
366 /* GObject implementation stuff {{{1 */
368 g_application_set_property (GObject
*object
,
373 GApplication
*application
= G_APPLICATION (object
);
377 case PROP_APPLICATION_ID
:
378 g_application_set_application_id (application
,
379 g_value_get_string (value
));
383 g_application_set_flags (application
, g_value_get_flags (value
));
386 case PROP_INACTIVITY_TIMEOUT
:
387 g_application_set_inactivity_timeout (application
,
388 g_value_get_uint (value
));
391 case PROP_ACTION_GROUP
:
392 g_application_set_action_group (application
,
393 g_value_get_object (value
));
397 g_assert_not_reached ();
402 * g_application_set_action_group:
403 * @application: a #GApplication
404 * @action_group: (allow-none): a #GActionGroup, or %NULL
406 * Sets or unsets the group of actions associated with the application.
408 * These actions are the actions that can be remotely invoked.
410 * It is an error to call this function after the application has been
416 g_application_set_action_group (GApplication
*application
,
417 GActionGroup
*action_group
)
419 g_return_if_fail (G_IS_APPLICATION (application
));
420 g_return_if_fail (!application
->priv
->is_registered
);
422 if (application
->priv
->actions
!= NULL
)
423 g_object_unref (application
->priv
->actions
);
425 application
->priv
->actions
= action_group
;
427 if (application
->priv
->actions
!= NULL
)
428 g_object_ref (application
->priv
->actions
);
432 g_application_get_property (GObject
*object
,
437 GApplication
*application
= G_APPLICATION (object
);
441 case PROP_APPLICATION_ID
:
442 g_value_set_string (value
,
443 g_application_get_application_id (application
));
447 g_value_set_flags (value
,
448 g_application_get_flags (application
));
451 case PROP_IS_REGISTERED
:
452 g_value_set_boolean (value
,
453 g_application_get_is_registered (application
));
457 g_value_set_boolean (value
,
458 g_application_get_is_remote (application
));
461 case PROP_INACTIVITY_TIMEOUT
:
462 g_value_set_uint (value
,
463 g_application_get_inactivity_timeout (application
));
467 g_assert_not_reached ();
472 g_application_constructed (GObject
*object
)
474 GApplication
*application
= G_APPLICATION (object
);
476 g_assert (application
->priv
->id
!= NULL
);
480 g_application_finalize (GObject
*object
)
482 GApplication
*application
= G_APPLICATION (object
);
484 if (application
->priv
->impl
)
485 g_application_impl_destroy (application
->priv
->impl
);
486 g_free (application
->priv
->id
);
488 G_OBJECT_CLASS (g_application_parent_class
)
493 g_application_init (GApplication
*application
)
495 application
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (application
,
497 GApplicationPrivate
);
501 g_application_class_init (GApplicationClass
*class)
503 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
505 object_class
->constructed
= g_application_constructed
;
506 object_class
->finalize
= g_application_finalize
;
507 object_class
->get_property
= g_application_get_property
;
508 object_class
->set_property
= g_application_set_property
;
510 class->before_emit
= g_application_real_before_emit
;
511 class->after_emit
= g_application_real_after_emit
;
512 class->startup
= g_application_real_startup
;
513 class->shutdown
= g_application_real_shutdown
;
514 class->activate
= g_application_real_activate
;
515 class->open
= g_application_real_open
;
516 class->command_line
= g_application_real_command_line
;
517 class->local_command_line
= g_application_real_local_command_line
;
518 class->add_platform_data
= g_application_real_add_platform_data
;
520 g_object_class_install_property (object_class
, PROP_APPLICATION_ID
,
521 g_param_spec_string ("application-id",
522 P_("Application identifier"),
523 P_("The unique identifier for the application"),
524 NULL
, G_PARAM_READWRITE
| G_PARAM_CONSTRUCT
|
525 G_PARAM_STATIC_STRINGS
));
527 g_object_class_install_property (object_class
, PROP_FLAGS
,
528 g_param_spec_flags ("flags",
529 P_("Application flags"),
530 P_("Flags specifying the behaviour of the application"),
531 G_TYPE_APPLICATION_FLAGS
, G_APPLICATION_FLAGS_NONE
,
532 G_PARAM_READWRITE
| G_PARAM_STATIC_STRINGS
));
534 g_object_class_install_property (object_class
, PROP_IS_REGISTERED
,
535 g_param_spec_boolean ("is-registered",
537 P_("If g_application_register() has been called"),
538 FALSE
, G_PARAM_READABLE
| G_PARAM_STATIC_STRINGS
));
540 g_object_class_install_property (object_class
, PROP_IS_REMOTE
,
541 g_param_spec_boolean ("is-remote",
543 P_("If this application instance is remote"),
544 FALSE
, G_PARAM_READABLE
| G_PARAM_STATIC_STRINGS
));
546 g_object_class_install_property (object_class
, PROP_INACTIVITY_TIMEOUT
,
547 g_param_spec_uint ("inactivity-timeout",
548 P_("Inactivity timeout"),
549 P_("Time (ms) to stay alive after becoming idle"),
551 G_PARAM_READWRITE
| G_PARAM_STATIC_STRINGS
));
553 g_object_class_install_property (object_class
, PROP_ACTION_GROUP
,
554 g_param_spec_object ("action-group",
556 P_("The group of actions that the application exports"),
558 G_PARAM_WRITABLE
| G_PARAM_STATIC_STRINGS
));
561 * GApplication::startup:
562 * @application: the application
564 * The ::startup signal is emitted on the primary instance immediately
565 * after registration. See g_application_register().
567 g_application_signals
[SIGNAL_STARTUP
] =
568 g_signal_new ("startup", G_TYPE_APPLICATION
, G_SIGNAL_RUN_LAST
,
569 G_STRUCT_OFFSET (GApplicationClass
, startup
),
570 NULL
, NULL
, g_cclosure_marshal_VOID__VOID
, G_TYPE_NONE
, 0);
573 * GApplication::shutdown:
574 * @application: the application
576 * The ::shutdown signal is emitted only on the registered primary instance
577 * immediately after the main loop terminates.
579 g_application_signals
[SIGNAL_SHUTDOWN
] =
580 g_signal_new ("shutdown", G_TYPE_APPLICATION
, G_SIGNAL_RUN_LAST
,
581 G_STRUCT_OFFSET (GApplicationClass
, shutdown
),
582 NULL
, NULL
, g_cclosure_marshal_VOID__VOID
, G_TYPE_NONE
, 0);
585 * GApplication::activate:
586 * @application: the application
588 * The ::activate signal is emitted on the primary instance when an
589 * activation occurs. See g_application_activate().
591 g_application_signals
[SIGNAL_ACTIVATE
] =
592 g_signal_new ("activate", G_TYPE_APPLICATION
, G_SIGNAL_RUN_LAST
,
593 G_STRUCT_OFFSET (GApplicationClass
, activate
),
594 NULL
, NULL
, g_cclosure_marshal_VOID__VOID
, G_TYPE_NONE
, 0);
598 * GApplication::open:
599 * @application: the application
600 * @files: (array length=n_files) (element-type GFile): an array of #GFiles
601 * @n_files: the length of @files
602 * @hint: a hint provided by the calling instance
604 * The ::open signal is emitted on the primary instance when there are
605 * files to open. See g_application_open() for more information.
607 g_application_signals
[SIGNAL_OPEN
] =
608 g_signal_new ("open", G_TYPE_APPLICATION
, G_SIGNAL_RUN_LAST
,
609 G_STRUCT_OFFSET (GApplicationClass
, open
),
611 G_TYPE_NONE
, 3, G_TYPE_POINTER
, G_TYPE_INT
, G_TYPE_STRING
);
614 * GApplication::command-line:
615 * @application: the application
616 * @command_line: a #GApplicationCommandLine representing the
619 * The ::command-line signal is emitted on the primary instance when
620 * a commandline is not handled locally. See g_application_run() and
621 * the #GApplicationCommandline documentation for more information.
623 * Returns: An integer that is set as the exit status for the calling
624 * process. See g_application_command_line_set_exit_status().
626 g_application_signals
[SIGNAL_COMMAND_LINE
] =
627 g_signal_new ("command-line", G_TYPE_APPLICATION
, G_SIGNAL_RUN_LAST
,
628 G_STRUCT_OFFSET (GApplicationClass
, command_line
),
629 g_signal_accumulator_first_wins
, NULL
,
631 G_TYPE_INT
, 1, G_TYPE_APPLICATION_COMMAND_LINE
);
633 g_type_class_add_private (class, sizeof (GApplicationPrivate
));
637 get_platform_data (GApplication
*application
)
639 GVariantBuilder
*builder
;
642 builder
= g_variant_builder_new (G_VARIANT_TYPE ("a{sv}"));
645 gchar
*cwd
= g_get_current_dir ();
646 g_variant_builder_add (builder
, "{sv}", "cwd",
647 g_variant_new_bytestring (cwd
));
651 if (application
->priv
->flags
& G_APPLICATION_SEND_ENVIRONMENT
)
656 envp
= g_get_environ ();
657 array
= g_variant_new_bytestring_array ((const gchar
**) envp
, -1);
660 g_variant_builder_add (builder
, "{sv}", "environ", array
);
663 G_APPLICATION_GET_CLASS (application
)->
664 add_platform_data (application
, builder
);
666 result
= g_variant_builder_end (builder
);
667 g_variant_builder_unref (builder
);
672 /* Application ID validity {{{1 */
675 * g_application_id_is_valid:
676 * @application_id: a potential application identifier
677 * @returns: %TRUE if @application_id is valid
679 * Checks if @application_id is a valid application identifier.
681 * A valid ID is required for calls to g_application_new() and
682 * g_application_set_application_id().
684 * For convenience, the restrictions on application identifiers are
687 * <listitem>Application identifiers must contain only the ASCII characters "[A-Z][a-z][0-9]_-." and must not begin with a digit.</listitem>
688 * <listitem>Application identifiers must contain at least one '.' (period) character (and thus at least three elements).</listitem>
689 * <listitem>Application identifiers must not begin or end with a '.' (period) character.</listitem>
690 * <listitem>Application identifiers must not contain consecutive '.' (period) characters.</listitem>
691 * <listitem>Application identifiers must not exceed 255 characters.</listitem>
695 g_application_id_is_valid (const gchar
*application_id
)
701 len
= strlen (application_id
);
706 if (!g_ascii_isalpha (application_id
[0]))
709 if (application_id
[len
-1] == '.')
715 for (; *application_id
; application_id
++)
717 if (g_ascii_isalnum (*application_id
) ||
718 (*application_id
== '-') ||
719 (*application_id
== '_'))
723 else if (allow_dot
&& *application_id
== '.')
738 /* Public Constructor {{{1 */
741 * @application_id: the application id
742 * @flags: the application flags
743 * @returns: a new #GApplication instance
745 * Creates a new #GApplication instance.
747 * This function calls g_type_init() for you.
749 * The application id must be valid. See g_application_id_is_valid().
752 g_application_new (const gchar
*application_id
,
753 GApplicationFlags flags
)
755 g_return_val_if_fail (g_application_id_is_valid (application_id
), NULL
);
759 return g_object_new (G_TYPE_APPLICATION
,
760 "application-id", application_id
,
765 /* Simple get/set: application id, flags, inactivity timeout {{{1 */
767 * g_application_get_application_id:
768 * @application: a #GApplication
769 * @returns: the identifier for @application, owned by @application
771 * Gets the unique identifier for @application.
776 g_application_get_application_id (GApplication
*application
)
778 g_return_val_if_fail (G_IS_APPLICATION (application
), NULL
);
780 return application
->priv
->id
;
784 * g_application_set_application_id:
785 * @application: a #GApplication
786 * @application_id: the identifier for @application
788 * Sets the unique identifier for @application.
790 * The application id can only be modified if @application has not yet
793 * The application id must be valid. See g_application_id_is_valid().
798 g_application_set_application_id (GApplication
*application
,
799 const gchar
*application_id
)
801 g_return_if_fail (G_IS_APPLICATION (application
));
803 if (g_strcmp0 (application
->priv
->id
, application_id
) != 0)
805 g_return_if_fail (g_application_id_is_valid (application_id
));
806 g_return_if_fail (!application
->priv
->is_registered
);
808 g_free (application
->priv
->id
);
809 application
->priv
->id
= g_strdup (application_id
);
811 g_object_notify (G_OBJECT (application
), "application-id");
816 * g_application_get_flags:
817 * @application: a #GApplication
818 * @returns: the flags for @application
820 * Gets the flags for @application.
822 * See #GApplicationFlags.
827 g_application_get_flags (GApplication
*application
)
829 g_return_val_if_fail (G_IS_APPLICATION (application
), 0);
831 return application
->priv
->flags
;
835 * g_application_set_flags:
836 * @application: a #GApplication
837 * @flags: the flags for @application
839 * Sets the flags for @application.
841 * The flags can only be modified if @application has not yet been
844 * See #GApplicationFlags.
849 g_application_set_flags (GApplication
*application
,
850 GApplicationFlags flags
)
852 g_return_if_fail (G_IS_APPLICATION (application
));
854 if (application
->priv
->flags
!= flags
)
856 g_return_if_fail (!application
->priv
->is_registered
);
858 application
->priv
->flags
= flags
;
860 g_object_notify (G_OBJECT (application
), "flags");
865 * g_application_get_inactivity_timeout:
866 * @application: a #GApplication
868 * Gets the current inactivity timeout for the application.
870 * This is the amount of time (in milliseconds) after the last call to
871 * g_application_release() before the application stops running.
873 * Returns: the timeout, in milliseconds
878 g_application_get_inactivity_timeout (GApplication
*application
)
880 g_return_val_if_fail (G_IS_APPLICATION (application
), 0);
882 return application
->priv
->inactivity_timeout
;
886 * g_application_set_inactivity_timeout:
887 * @application: a #GApplication
888 * @inactivity_timeout: the timeout, in milliseconds
890 * Sets the current inactivity timeout for the application.
892 * This is the amount of time (in milliseconds) after the last call to
893 * g_application_release() before the application stops running.
895 * This call has no side effects of its own. The value set here is only
896 * used for next time g_application_release() drops the use count to
897 * zero. Any timeouts currently in progress are not impacted.
902 g_application_set_inactivity_timeout (GApplication
*application
,
903 guint inactivity_timeout
)
905 g_return_if_fail (G_IS_APPLICATION (application
));
907 if (application
->priv
->inactivity_timeout
!= inactivity_timeout
)
909 application
->priv
->inactivity_timeout
= inactivity_timeout
;
911 g_object_notify (G_OBJECT (application
), "inactivity-timeout");
914 /* Read-only property getters (is registered, is remote) {{{1 */
916 * g_application_get_is_registered:
917 * @application: a #GApplication
918 * @returns: %TRUE if @application is registered
920 * Checks if @application is registered.
922 * An application is registered if g_application_register() has been
923 * successfully called.
928 g_application_get_is_registered (GApplication
*application
)
930 g_return_val_if_fail (G_IS_APPLICATION (application
), FALSE
);
932 return application
->priv
->is_registered
;
936 * g_application_get_is_remote:
937 * @application: a #GApplication
938 * @returns: %TRUE if @application is remote
940 * Checks if @application is remote.
942 * If @application is remote then it means that another instance of
943 * application already exists (the 'primary' instance). Calls to
944 * perform actions on @application will result in the actions being
945 * performed by the primary instance.
947 * The value of this property cannot be accessed before
948 * g_application_register() has been called. See
949 * g_application_get_is_registered().
954 g_application_get_is_remote (GApplication
*application
)
956 g_return_val_if_fail (G_IS_APPLICATION (application
), FALSE
);
957 g_return_val_if_fail (application
->priv
->is_registered
, FALSE
);
959 return application
->priv
->is_remote
;
964 * g_application_register:
965 * @application: a #GApplication
966 * @cancellable: a #GCancellable, or %NULL
967 * @error: a pointer to a NULL #GError, or %NULL
968 * @returns: %TRUE if registration succeeded
970 * Attempts registration of the application.
972 * This is the point at which the application discovers if it is the
973 * primary instance or merely acting as a remote for an already-existing
974 * primary instance. This is implemented by attempting to acquire the
975 * application identifier as a unique bus name on the session bus using
978 * Due to the internal architecture of GDBus, method calls can be
979 * dispatched at any time (even if a main loop is not running). For
980 * this reason, you must ensure that any object paths that you wish to
981 * register are registered before calling this function.
983 * If the application has already been registered then %TRUE is
984 * returned with no work performed.
986 * The #GApplication::startup signal is emitted if registration succeeds
987 * and @application is the primary instance.
989 * In the event of an error (such as @cancellable being cancelled, or a
990 * failure to connect to the session bus), %FALSE is returned and @error
991 * is set appropriately.
993 * Note: the return value of this function is not an indicator that this
994 * instance is or is not the primary instance of the application. See
995 * g_application_get_is_remote() for that.
1000 g_application_register (GApplication
*application
,
1001 GCancellable
*cancellable
,
1004 g_return_val_if_fail (G_IS_APPLICATION (application
), FALSE
);
1006 if (!application
->priv
->is_registered
)
1008 if (~application
->priv
->flags
& G_APPLICATION_NON_UNIQUE
)
1010 application
->priv
->impl
=
1011 g_application_impl_register (application
, application
->priv
->id
,
1012 application
->priv
->flags
,
1013 &application
->priv
->remote_actions
,
1014 cancellable
, error
);
1016 if (application
->priv
->impl
== NULL
)
1020 application
->priv
->is_remote
= application
->priv
->remote_actions
!= NULL
;
1021 application
->priv
->is_registered
= TRUE
;
1023 g_object_notify (G_OBJECT (application
), "is-registered");
1025 if (!application
->priv
->is_remote
)
1027 g_signal_emit (application
, g_application_signals
[SIGNAL_STARTUP
], 0);
1029 if (!application
->priv
->did_startup
)
1030 g_critical ("GApplication subclass '%s' failed to chain up on"
1031 " ::startup (from start of override function)",
1032 G_OBJECT_TYPE_NAME (application
));
1039 /* Hold/release {{{1 */
1041 * g_application_hold:
1042 * @application: a #GApplication
1044 * Increases the use count of @application.
1046 * Use this function to indicate that the application has a reason to
1047 * continue to run. For example, g_application_hold() is called by GTK+
1048 * when a toplevel window is on the screen.
1050 * To cancel the hold, call g_application_release().
1053 g_application_hold (GApplication
*application
)
1055 if (application
->priv
->inactivity_timeout_id
)
1057 g_source_remove (application
->priv
->inactivity_timeout_id
);
1058 application
->priv
->inactivity_timeout_id
= 0;
1061 application
->priv
->use_count
++;
1065 inactivity_timeout_expired (gpointer data
)
1067 GApplication
*application
= G_APPLICATION (data
);
1069 application
->priv
->inactivity_timeout_id
= 0;
1076 * g_application_release:
1077 * @application: a #GApplication
1079 * Decrease the use count of @application.
1081 * When the use count reaches zero, the application will stop running.
1083 * Never call this function except to cancel the effect of a previous
1084 * call to g_application_hold().
1087 g_application_release (GApplication
*application
)
1089 application
->priv
->use_count
--;
1091 if (application
->priv
->use_count
== 0 && application
->priv
->inactivity_timeout
)
1092 application
->priv
->inactivity_timeout_id
= g_timeout_add (application
->priv
->inactivity_timeout
,
1093 inactivity_timeout_expired
, application
);
1096 /* Activate, Open {{{1 */
1098 * g_application_activate:
1099 * @application: a #GApplication
1101 * Activates the application.
1103 * In essence, this results in the #GApplication::activate() signal being
1104 * emitted in the primary instance.
1106 * The application must be registered before calling this function.
1111 g_application_activate (GApplication
*application
)
1113 g_return_if_fail (G_IS_APPLICATION (application
));
1114 g_return_if_fail (application
->priv
->is_registered
);
1116 if (application
->priv
->is_remote
)
1117 g_application_impl_activate (application
->priv
->impl
,
1118 get_platform_data (application
));
1121 g_signal_emit (application
, g_application_signals
[SIGNAL_ACTIVATE
], 0);
1125 * g_application_open:
1126 * @application: a #GApplication
1127 * @files: (array length=n_files): an array of #GFiles to open
1128 * @n_files: the length of the @files array
1129 * @hint: a hint (or ""), but never %NULL
1131 * Opens the given files.
1133 * In essence, this results in the #GApplication::open signal being emitted
1134 * in the primary instance.
1136 * @n_files must be greater than zero.
1138 * @hint is simply passed through to the ::open signal. It is
1139 * intended to be used by applications that have multiple modes for
1140 * opening files (eg: "view" vs "edit", etc). Unless you have a need
1141 * for this functionality, you should use "".
1143 * The application must be registered before calling this function
1144 * and it must have the %G_APPLICATION_HANDLES_OPEN flag set.
1149 g_application_open (GApplication
*application
,
1154 g_return_if_fail (G_IS_APPLICATION (application
));
1155 g_return_if_fail (application
->priv
->flags
&
1156 G_APPLICATION_HANDLES_OPEN
);
1157 g_return_if_fail (application
->priv
->is_registered
);
1159 if (application
->priv
->is_remote
)
1160 g_application_impl_open (application
->priv
->impl
,
1161 files
, n_files
, hint
,
1162 get_platform_data (application
));
1165 g_signal_emit (application
, g_application_signals
[SIGNAL_OPEN
],
1166 0, files
, n_files
, hint
);
1171 * g_application_run:
1172 * @application: a #GApplication
1173 * @argc: the argc from main() (or 0 if @argv is %NULL)
1174 * @argv: (array length=argc) (allow-none): the argv from main(), or %NULL
1175 * @returns: the exit status
1177 * Runs the application.
1179 * This function is intended to be run from main() and its return value
1180 * is intended to be returned by main(). Although you are expected to pass
1181 * the @argc, @argv parameters from main() to this function, it is possible
1182 * to pass %NULL if @argv is not available or commandline handling is not
1185 * First, the local_command_line() virtual function is invoked.
1186 * This function always runs on the local instance. It gets passed a pointer
1187 * to a %NULL-terminated copy of @argv and is expected to remove the arguments
1188 * that it handled (shifting up remaining arguments). See
1189 * <xref linkend="gapplication-example-cmdline2"/> for an example of
1190 * parsing @argv manually. Alternatively, you may use the #GOptionContext API,
1191 * after setting <literal>argc = g_strv_length (argv);</literal>.
1193 * The last argument to local_command_line() is a pointer to the @status
1194 * variable which can used to set the exit status that is returned from
1195 * g_application_run().
1197 * If local_command_line() returns %TRUE, the command line is expected
1198 * to be completely handled, including possibly registering as the primary
1199 * instance, calling g_application_activate() or g_application_open(), etc.
1201 * If local_command_line() returns %FALSE then the application is registered
1202 * and the #GApplication::command-line signal is emitted in the primary
1203 * instance (which may or may not be this instance). The signal handler
1204 * gets passed a #GApplicationCommandline object that (among other things)
1205 * contains the remaining commandline arguments that have not been handled
1206 * by local_command_line().
1208 * If the application has the %G_APPLICATION_HANDLES_COMMAND_LINE
1209 * flag set then the default implementation of local_command_line()
1210 * always returns %FALSE immediately, resulting in the commandline
1211 * always being handled in the primary instance.
1213 * Otherwise, the default implementation of local_command_line() tries
1214 * to do a couple of things that are probably reasonable for most
1215 * applications. First, g_application_register() is called to attempt
1216 * to register the application. If that works, then the command line
1217 * arguments are inspected. If no commandline arguments are given, then
1218 * g_application_activate() is called. If commandline arguments are
1219 * given and the %G_APPLICATION_HANDLES_OPEN flag is set then they
1220 * are assumed to be filenames and g_application_open() is called.
1222 * If you need to handle commandline arguments that are not filenames,
1223 * and you don't mind commandline handling to happen in the primary
1224 * instance, you should set %G_APPLICATION_HANDLED_COMMAND_LINE and
1225 * process the commandline arguments in your #GApplication::command-line
1226 * signal handler, either manually or using the #GOptionContext API.
1228 * If you are interested in doing more complicated local handling of the
1229 * commandline then you should implement your own #GApplication subclass
1230 * and override local_command_line(). In this case, you most likely want
1231 * to return %TRUE from your local_command_line() implementation to
1232 * suppress the default handling. See
1233 * <xref linkend="gapplication-example-cmdline2"/> for an example.
1235 * If, after the above is done, the use count of the application is zero
1236 * then the exit status is returned immediately. If the use count is
1237 * non-zero then the mainloop is run until the use count falls to zero,
1238 * at which point 0 is returned.
1240 * If the %G_APPLICATION_IS_SERVICE flag is set, then the exiting at
1241 * use count of zero is delayed for a while (ie: the instance stays
1242 * around to provide its <emphasis>service</emphasis> to others).
1247 g_application_run (GApplication
*application
,
1255 g_return_val_if_fail (G_IS_APPLICATION (application
), 1);
1256 g_return_val_if_fail (argc
== 0 || argv
!= NULL
, 1);
1258 arguments
= g_new (gchar
*, argc
+ 1);
1259 for (i
= 0; i
< argc
; i
++)
1260 arguments
[i
] = g_strdup (argv
[i
]);
1261 arguments
[i
] = NULL
;
1263 if (g_get_prgname () == NULL
&& argc
> 0)
1267 prgname
= g_path_get_basename (argv
[0]);
1268 g_set_prgname (prgname
);
1272 if (!G_APPLICATION_GET_CLASS (application
)
1273 ->local_command_line (application
, &arguments
, &status
))
1275 GError
*error
= NULL
;
1277 if (!g_application_register (application
, NULL
, &error
))
1279 g_printerr ("%s", error
->message
);
1280 g_error_free (error
);
1284 if (application
->priv
->is_remote
)
1286 GVariant
*platform_data
;
1288 platform_data
= get_platform_data (application
);
1289 status
= g_application_impl_command_line (application
->priv
->impl
,
1290 arguments
, platform_data
);
1294 GApplicationCommandLine
*cmdline
;
1297 v
= g_variant_new_bytestring_array ((const gchar
**) arguments
, -1);
1298 cmdline
= g_object_new (G_TYPE_APPLICATION_COMMAND_LINE
,
1299 "arguments", v
, NULL
);
1300 g_signal_emit (application
,
1301 g_application_signals
[SIGNAL_COMMAND_LINE
],
1302 0, cmdline
, &status
);
1303 g_object_unref (cmdline
);
1307 g_strfreev (arguments
);
1309 if (application
->priv
->flags
& G_APPLICATION_IS_SERVICE
&&
1310 application
->priv
->is_registered
&&
1311 !application
->priv
->use_count
&&
1312 !application
->priv
->inactivity_timeout_id
)
1314 application
->priv
->inactivity_timeout_id
=
1315 g_timeout_add (10000, inactivity_timeout_expired
, application
);
1318 while (application
->priv
->use_count
|| application
->priv
->inactivity_timeout_id
)
1320 g_main_context_iteration (NULL
, TRUE
);
1324 if (!application
->priv
->is_remote
)
1326 g_signal_emit (application
, g_application_signals
[SIGNAL_SHUTDOWN
], 0);
1328 if (!application
->priv
->did_shutdown
)
1329 g_critical ("GApplication subclass '%s' failed to chain up on"
1330 " ::shutdown (from end of override function)",
1331 G_OBJECT_TYPE_NAME (application
));
1334 if (application
->priv
->impl
)
1335 g_application_impl_flush (application
->priv
->impl
);
1343 g_application_has_action (GActionGroup
*action_group
,
1344 const gchar
*action_name
)
1346 GApplication
*application
= G_APPLICATION (action_group
);
1348 g_return_val_if_fail (application
->priv
->is_registered
, FALSE
);
1350 if (application
->priv
->remote_actions
!= NULL
)
1351 return g_hash_table_lookup (application
->priv
->remote_actions
,
1352 action_name
) != NULL
;
1354 return application
->priv
->actions
&&
1355 g_action_group_has_action (application
->priv
->actions
, action_name
);
1359 g_application_list_actions (GActionGroup
*action_group
)
1361 GApplication
*application
= G_APPLICATION (action_group
);
1363 g_return_val_if_fail (application
->priv
->is_registered
, NULL
);
1365 if (application
->priv
->remote_actions
!= NULL
)
1367 GHashTableIter iter
;
1372 n
= g_hash_table_size (application
->priv
->remote_actions
);
1373 keys
= g_new (gchar
*, n
+ 1);
1375 g_hash_table_iter_init (&iter
, application
->priv
->remote_actions
);
1376 while (g_hash_table_iter_next (&iter
, &key
, NULL
))
1377 keys
[i
++] = g_strdup (key
);
1378 g_assert_cmpint (i
, ==, n
);
1384 else if (application
->priv
->actions
!= NULL
)
1385 return g_action_group_list_actions (application
->priv
->actions
);
1388 /* empty string array */
1389 return g_new0 (gchar
*, 1);
1393 g_application_get_action_enabled (GActionGroup
*action_group
,
1394 const gchar
*action_name
)
1396 GApplication
*application
= G_APPLICATION (action_group
);
1398 g_return_val_if_fail (application
->priv
->remote_actions
!= NULL
||
1399 application
->priv
->actions
!= NULL
, FALSE
);
1400 g_return_val_if_fail (application
->priv
->is_registered
, FALSE
);
1402 if (application
->priv
->remote_actions
)
1404 RemoteActionInfo
*info
;
1406 info
= g_hash_table_lookup (application
->priv
->remote_actions
,
1409 return info
&& info
->enabled
;
1412 return g_action_group_get_action_enabled (application
->priv
->actions
,
1416 static const GVariantType
*
1417 g_application_get_action_parameter_type (GActionGroup
*action_group
,
1418 const gchar
*action_name
)
1420 GApplication
*application
= G_APPLICATION (action_group
);
1422 g_return_val_if_fail (application
->priv
->remote_actions
!= NULL
||
1423 application
->priv
->actions
!= NULL
, NULL
);
1424 g_return_val_if_fail (application
->priv
->is_registered
, NULL
);
1426 if (application
->priv
->remote_actions
)
1428 RemoteActionInfo
*info
;
1430 info
= g_hash_table_lookup (application
->priv
->remote_actions
,
1434 return info
->parameter_type
;
1439 return g_action_group_get_action_parameter_type (application
->priv
->actions
,
1443 static const GVariantType
*
1444 g_application_get_action_state_type (GActionGroup
*action_group
,
1445 const gchar
*action_name
)
1447 GApplication
*application
= G_APPLICATION (action_group
);
1449 g_return_val_if_fail (application
->priv
->remote_actions
!= NULL
||
1450 application
->priv
->actions
!= NULL
, NULL
);
1451 g_return_val_if_fail (application
->priv
->is_registered
, NULL
);
1453 if (application
->priv
->remote_actions
)
1455 RemoteActionInfo
*info
;
1457 info
= g_hash_table_lookup (application
->priv
->remote_actions
,
1460 if (info
&& info
->state
)
1461 return g_variant_get_type (info
->state
);
1466 return g_action_group_get_action_state_type (application
->priv
->actions
,
1471 g_application_get_action_state (GActionGroup
*action_group
,
1472 const gchar
*action_name
)
1474 GApplication
*application
= G_APPLICATION (action_group
);
1476 g_return_val_if_fail (application
->priv
->remote_actions
!= NULL
||
1477 application
->priv
->actions
!= NULL
, NULL
);
1478 g_return_val_if_fail (application
->priv
->is_registered
, NULL
);
1480 if (application
->priv
->remote_actions
)
1482 RemoteActionInfo
*info
;
1484 info
= g_hash_table_lookup (application
->priv
->remote_actions
,
1487 if (info
&& info
->state
)
1488 return g_variant_ref (info
->state
);
1493 return g_action_group_get_action_state (application
->priv
->actions
,
1498 g_application_change_action_state (GActionGroup
*action_group
,
1499 const gchar
*action_name
,
1502 GApplication
*application
= G_APPLICATION (action_group
);
1504 g_return_if_fail (application
->priv
->is_remote
||
1505 application
->priv
->actions
!= NULL
);
1506 g_return_if_fail (application
->priv
->is_registered
);
1508 if (application
->priv
->is_remote
)
1509 g_application_impl_change_action_state (application
->priv
->impl
,
1511 get_platform_data (application
));
1514 g_action_group_change_action_state (application
->priv
->actions
,
1515 action_name
, value
);
1519 g_application_activate_action (GActionGroup
*action_group
,
1520 const gchar
*action_name
,
1521 GVariant
*parameter
)
1523 GApplication
*application
= G_APPLICATION (action_group
);
1525 g_return_if_fail (application
->priv
->is_remote
||
1526 application
->priv
->actions
!= NULL
);
1527 g_return_if_fail (application
->priv
->is_registered
);
1529 if (application
->priv
->is_remote
)
1530 g_application_impl_activate_action (application
->priv
->impl
,
1531 action_name
, parameter
,
1532 get_platform_data (application
));
1535 g_action_group_activate_action (application
->priv
->actions
,
1536 action_name
, parameter
);
1540 g_application_action_group_iface_init (GActionGroupInterface
*iface
)
1542 iface
->has_action
= g_application_has_action
;
1543 iface
->list_actions
= g_application_list_actions
;
1545 iface
->get_action_enabled
= g_application_get_action_enabled
;
1546 iface
->get_action_parameter_type
= g_application_get_action_parameter_type
;
1547 iface
->get_action_state_type
= g_application_get_action_state_type
;
1548 iface
->get_action_state
= g_application_get_action_state
;
1549 iface
->change_action_state
= g_application_change_action_state
;
1550 iface
->activate_action
= g_application_activate_action
;
1554 /* vim:set foldmethod=marker: */