1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Alexander Larsson <alexl@redhat.com>
33 * @short_description: Application information and launch contexts
36 * #GAppInfo and #GAppLaunchContext are used for describing and launching
37 * applications installed on the system.
39 * As of GLib 2.20, URIs will always be converted to POSIX paths
40 * (using g_file_get_path()) when using g_app_info_launch() even if
41 * the application requested an URI and not a POSIX path. For example
42 * for an desktop-file based application with Exec key <literal>totem
43 * %%U</literal> and a single URI,
44 * <literal>sftp://foo/file.avi</literal>, then
45 * <literal>/home/user/.gvfs/sftp on foo/file.avi</literal> will be
46 * passed. This will only work if a set of suitable GIO extensions
47 * (such as gvfs 2.26 compiled with FUSE support), is available and
48 * operational; if this is not the case, the URI will be passed
49 * unmodified to the application. Some URIs, such as
50 * <literal>mailto:</literal>, of course cannot be mapped to a POSIX
51 * path (in gvfs there's no FUSE mount for it); such URIs will be
52 * passed unmodified to the application.
54 * Specifically for gvfs 2.26 and later, the POSIX URI will be mapped
55 * back to the GIO URI in the #GFile constructors (since gvfs
56 * implements the #GVfs extension point). As such, if the application
57 * needs to examine the URI, it needs to use g_file_get_uri() or
58 * similar on #GFile. In other words, an application cannot assume
59 * that the URI passed to e.g. g_file_new_for_commandline_arg() is
60 * equal to the result of g_file_get_uri(). The following snippet
67 * file = g_file_new_for_commandline_arg (uri_from_commandline);
69 * uri = g_file_get_uri (file);
70 * strcmp (uri, uri_from_commandline) == 0; // FALSE
73 * if (g_file_has_uri_scheme (file, "cdda"))
75 * // do something special with uri
77 * g_object_unref (file);
80 * This code will work when both <literal>cdda://sr0/Track
81 * 1.wav</literal> and <literal>/home/user/.gvfs/cdda on sr0/Track
82 * 1.wav</literal> is passed to the application. It should be noted
83 * that it's generally not safe for applications to rely on the format
84 * of a particular URIs. Different launcher applications (e.g. file
85 * managers) may have different ideas of what a given URI means.
89 static void g_app_info_base_init (gpointer g_class);
90 static void g_app_info_class_init (gpointer g_class,
95 g_app_info_get_type (void)
97 static volatile gsize g_define_type_id__volatile = 0;
99 if (g_once_init_enter (&g_define_type_id__volatile))
101 const GTypeInfo app_info_info =
103 sizeof (GAppInfoIface), /* class_size */
104 g_app_info_base_init, /* base_init */
105 NULL, /* base_finalize */
106 g_app_info_class_init,
107 NULL, /* class_finalize */
108 NULL, /* class_data */
113 GType g_define_type_id =
114 g_type_register_static (G_TYPE_INTERFACE, I_("GAppInfo"),
117 g_type_interface_add_prerequisite (g_define_type_id, G_TYPE_OBJECT);
119 g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
122 return g_define_type_id__volatile;
126 g_app_info_class_init (gpointer g_class,
132 g_app_info_base_init (gpointer g_class)
139 * @appinfo: a #GAppInfo.
141 * Creates a duplicate of a #GAppInfo.
143 * Returns: a duplicate of @appinfo.
146 g_app_info_dup (GAppInfo *appinfo)
148 GAppInfoIface *iface;
150 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
152 iface = G_APP_INFO_GET_IFACE (appinfo);
154 return (* iface->dup) (appinfo);
159 * @appinfo1: the first #GAppInfo.
160 * @appinfo2: the second #GAppInfo.
162 * Checks if two #GAppInfos are equal.
164 * Returns: %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise.
167 g_app_info_equal (GAppInfo *appinfo1,
170 GAppInfoIface *iface;
172 g_return_val_if_fail (G_IS_APP_INFO (appinfo1), FALSE);
173 g_return_val_if_fail (G_IS_APP_INFO (appinfo2), FALSE);
175 if (G_TYPE_FROM_INSTANCE (appinfo1) != G_TYPE_FROM_INSTANCE (appinfo2))
178 iface = G_APP_INFO_GET_IFACE (appinfo1);
180 return (* iface->equal) (appinfo1, appinfo2);
185 * @appinfo: a #GAppInfo.
187 * Gets the ID of an application. An id is a string that
188 * identifies the application. The exact format of the id is
189 * platform dependent. For instance, on Unix this is the
190 * desktop file id from the xdg menu specification.
192 * Note that the returned ID may be %NULL, depending on how
193 * the @appinfo has been constructed.
195 * Returns: a string containing the application's ID.
198 g_app_info_get_id (GAppInfo *appinfo)
200 GAppInfoIface *iface;
202 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
204 iface = G_APP_INFO_GET_IFACE (appinfo);
206 return (* iface->get_id) (appinfo);
210 * g_app_info_get_name:
211 * @appinfo: a #GAppInfo.
213 * Gets the installed name of the application.
215 * Returns: the name of the application for @appinfo.
218 g_app_info_get_name (GAppInfo *appinfo)
220 GAppInfoIface *iface;
222 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
224 iface = G_APP_INFO_GET_IFACE (appinfo);
226 return (* iface->get_name) (appinfo);
230 * g_app_info_get_description:
231 * @appinfo: a #GAppInfo.
233 * Gets a human-readable description of an installed application.
235 * Returns: a string containing a description of the
236 * application @appinfo, or %NULL if none.
239 g_app_info_get_description (GAppInfo *appinfo)
241 GAppInfoIface *iface;
243 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
245 iface = G_APP_INFO_GET_IFACE (appinfo);
247 return (* iface->get_description) (appinfo);
251 * g_app_info_get_executable:
252 * @appinfo: a #GAppInfo.
254 * Gets the executable's name for the installed application.
256 * Returns: a string containing the @appinfo's application
260 g_app_info_get_executable (GAppInfo *appinfo)
262 GAppInfoIface *iface;
264 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
266 iface = G_APP_INFO_GET_IFACE (appinfo);
268 return (* iface->get_executable) (appinfo);
273 * g_app_info_set_as_default_for_type:
274 * @appinfo: a #GAppInfo.
275 * @content_type: the content type.
278 * Sets the application as the default handler for a given type.
280 * Returns: %TRUE on success, %FALSE on error.
283 g_app_info_set_as_default_for_type (GAppInfo *appinfo,
284 const char *content_type,
287 GAppInfoIface *iface;
289 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
290 g_return_val_if_fail (content_type != NULL, FALSE);
292 iface = G_APP_INFO_GET_IFACE (appinfo);
294 return (* iface->set_as_default_for_type) (appinfo, content_type, error);
299 * g_app_info_set_as_default_for_extension:
300 * @appinfo: a #GAppInfo.
301 * @extension: a string containing the file extension (without the dot).
304 * Sets the application as the default handler for the given file extention.
306 * Returns: %TRUE on success, %FALSE on error.
309 g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
310 const char *extension,
313 GAppInfoIface *iface;
315 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
316 g_return_val_if_fail (extension != NULL, FALSE);
318 iface = G_APP_INFO_GET_IFACE (appinfo);
320 if (iface->set_as_default_for_extension)
321 return (* iface->set_as_default_for_extension) (appinfo, extension, error);
323 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
324 "g_app_info_set_as_default_for_extension not supported yet");
330 * g_app_info_add_supports_type:
331 * @appinfo: a #GAppInfo.
332 * @content_type: a string.
335 * Adds a content type to the application information to indicate the
336 * application is capable of opening files with the given content type.
338 * Returns: %TRUE on success, %FALSE on error.
341 g_app_info_add_supports_type (GAppInfo *appinfo,
342 const char *content_type,
345 GAppInfoIface *iface;
347 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
348 g_return_val_if_fail (content_type != NULL, FALSE);
350 iface = G_APP_INFO_GET_IFACE (appinfo);
352 if (iface->add_supports_type)
353 return (* iface->add_supports_type) (appinfo, content_type, error);
355 g_set_error_literal (error, G_IO_ERROR,
356 G_IO_ERROR_NOT_SUPPORTED,
357 "g_app_info_add_supports_type not supported yet");
364 * g_app_info_can_remove_supports_type:
365 * @appinfo: a #GAppInfo.
367 * Checks if a supported content type can be removed from an application.
369 * Returns: %TRUE if it is possible to remove supported
370 * content types from a given @appinfo, %FALSE if not.
373 g_app_info_can_remove_supports_type (GAppInfo *appinfo)
375 GAppInfoIface *iface;
377 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
379 iface = G_APP_INFO_GET_IFACE (appinfo);
381 if (iface->can_remove_supports_type)
382 return (* iface->can_remove_supports_type) (appinfo);
389 * g_app_info_remove_supports_type:
390 * @appinfo: a #GAppInfo.
391 * @content_type: a string.
394 * Removes a supported type from an application, if possible.
396 * Returns: %TRUE on success, %FALSE on error.
399 g_app_info_remove_supports_type (GAppInfo *appinfo,
400 const char *content_type,
403 GAppInfoIface *iface;
405 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
406 g_return_val_if_fail (content_type != NULL, FALSE);
408 iface = G_APP_INFO_GET_IFACE (appinfo);
410 if (iface->remove_supports_type)
411 return (* iface->remove_supports_type) (appinfo, content_type, error);
413 g_set_error_literal (error, G_IO_ERROR,
414 G_IO_ERROR_NOT_SUPPORTED,
415 "g_app_info_remove_supports_type not supported yet");
422 * g_app_info_get_icon:
423 * @appinfo: a #GAppInfo.
425 * Gets the icon for the application.
427 * Returns: the default #GIcon for @appinfo.
430 g_app_info_get_icon (GAppInfo *appinfo)
432 GAppInfoIface *iface;
434 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
436 iface = G_APP_INFO_GET_IFACE (appinfo);
438 return (* iface->get_icon) (appinfo);
444 * @appinfo: a #GAppInfo
445 * @files: a #GList of #GFile objects
446 * @launch_context: a #GAppLaunchContext or %NULL
449 * Launches the application. Passes @files to the launched application
450 * as arguments, using the optional @launch_context to get information
451 * about the details of the launcher (like what screen it is on).
452 * On error, @error will be set accordingly.
454 * To lauch the application without arguments pass a %NULL @files list.
456 * Note that even if the launch is successful the application launched
457 * can fail to start if it runs into problems during startup. There is
458 * no way to detect this.
460 * Some URIs can be changed when passed through a GFile (for instance
461 * unsupported uris with strange formats like mailto:), so if you have
462 * a textual uri you want to pass in as argument, consider using
463 * g_app_info_launch_uris() instead.
465 * Returns: %TRUE on successful launch, %FALSE otherwise.
468 g_app_info_launch (GAppInfo *appinfo,
470 GAppLaunchContext *launch_context,
473 GAppInfoIface *iface;
475 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
477 iface = G_APP_INFO_GET_IFACE (appinfo);
479 return (* iface->launch) (appinfo, files, launch_context, error);
484 * g_app_info_supports_uris:
485 * @appinfo: a #GAppInfo.
487 * Checks if the application supports reading files and directories from URIs.
489 * Returns: %TRUE if the @appinfo supports URIs.
492 g_app_info_supports_uris (GAppInfo *appinfo)
494 GAppInfoIface *iface;
496 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
498 iface = G_APP_INFO_GET_IFACE (appinfo);
500 return (* iface->supports_uris) (appinfo);
505 * g_app_info_supports_files:
506 * @appinfo: a #GAppInfo.
508 * Checks if the application accepts files as arguments.
510 * Returns: %TRUE if the @appinfo supports files.
513 g_app_info_supports_files (GAppInfo *appinfo)
515 GAppInfoIface *iface;
517 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
519 iface = G_APP_INFO_GET_IFACE (appinfo);
521 return (* iface->supports_files) (appinfo);
526 * g_app_info_launch_uris:
527 * @appinfo: a #GAppInfo
528 * @uris: a #GList containing URIs to launch.
529 * @launch_context: a #GAppLaunchContext or %NULL
532 * Launches the application. Passes @uris to the launched application
533 * as arguments, using the optional @launch_context to get information
534 * about the details of the launcher (like what screen it is on).
535 * On error, @error will be set accordingly.
537 * To lauch the application without arguments pass a %NULL @uris list.
539 * Note that even if the launch is successful the application launched
540 * can fail to start if it runs into problems during startup. There is
541 * no way to detect this.
543 * Returns: %TRUE on successful launch, %FALSE otherwise.
546 g_app_info_launch_uris (GAppInfo *appinfo,
548 GAppLaunchContext *launch_context,
551 GAppInfoIface *iface;
553 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
555 iface = G_APP_INFO_GET_IFACE (appinfo);
557 return (* iface->launch_uris) (appinfo, uris, launch_context, error);
562 * g_app_info_should_show:
563 * @appinfo: a #GAppInfo.
565 * Checks if the application info should be shown in menus that
566 * list available applications.
568 * Returns: %TRUE if the @appinfo should be shown, %FALSE otherwise.
571 g_app_info_should_show (GAppInfo *appinfo)
573 GAppInfoIface *iface;
575 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
577 iface = G_APP_INFO_GET_IFACE (appinfo);
579 return (* iface->should_show) (appinfo);
583 * g_app_info_launch_default_for_uri:
584 * @uri: the uri to show
585 * @launch_context: an optional #GAppLaunchContext.
588 * Utility function that launches the default application
589 * registered to handle the specified uri. Synchronous I/O
590 * is done on the uri to detext the type of the file if
593 * Returns: %TRUE on success, %FALSE on error.
596 g_app_info_launch_default_for_uri (const char *uri,
597 GAppLaunchContext *launch_context,
605 file = g_file_new_for_uri (uri);
606 app_info = g_file_query_default_handler (file, NULL, error);
607 g_object_unref (file);
608 if (app_info == NULL)
611 /* Use the uri, not the GFile, as the GFile roundtrip may
612 * affect the uri which we don't want (for instance for a
615 l.data = (char *)uri;
616 l.next = l.prev = NULL;
617 res = g_app_info_launch_uris (app_info, &l,
618 launch_context, error);
620 g_object_unref (app_info);
626 * g_app_info_can_delete:
627 * @appinfo: a #GAppInfo
629 * Obtains the information whether the GAppInfo can be deleted.
630 * See g_app_info_delete().
632 * Returns: %TRUE if @appinfo can be deleted
637 g_app_info_can_delete (GAppInfo *appinfo)
639 GAppInfoIface *iface;
641 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
643 iface = G_APP_INFO_GET_IFACE (appinfo);
645 if (iface->can_delete)
646 return (* iface->can_delete) (appinfo);
654 * @appinfo: a #GAppInfo
656 * Tries to delete an #GAppInfo.
658 * On some platforms, there may be a difference between user-defined
659 * #GAppInfo<!-- -->s which can be deleted, and system-wide ones which
660 * cannot. See g_app_info_can_delete().
662 * Returns: %TRUE if @appinfo has been deleted
667 g_app_info_delete (GAppInfo *appinfo)
669 GAppInfoIface *iface;
671 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
673 iface = G_APP_INFO_GET_IFACE (appinfo);
675 if (iface->do_delete)
676 return (* iface->do_delete) (appinfo);
682 G_DEFINE_TYPE (GAppLaunchContext, g_app_launch_context, G_TYPE_OBJECT);
685 * g_app_launch_context_new:
687 * Creates a new application launch context. This is not normally used,
688 * instead you instantiate a subclass of this, such as #GdkAppLaunchContext.
690 * Returns: a #GAppLaunchContext.
693 g_app_launch_context_new (void)
695 return g_object_new (G_TYPE_APP_LAUNCH_CONTEXT, NULL);
699 g_app_launch_context_class_init (GAppLaunchContextClass *klass)
704 g_app_launch_context_init (GAppLaunchContext *launch_context)
709 * g_app_launch_context_get_display:
710 * @context: a #GAppLaunchContext
712 * @files: a #GList of #GFile objects
714 * Gets the display string for the display. This is used to ensure new
715 * applications are started on the same display as the launching
718 * Returns: a display string for the display.
721 g_app_launch_context_get_display (GAppLaunchContext *context,
725 GAppLaunchContextClass *class;
727 g_return_val_if_fail (G_IS_APP_LAUNCH_CONTEXT (context), NULL);
728 g_return_val_if_fail (G_IS_APP_INFO (info), NULL);
730 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
732 if (class->get_display == NULL)
735 return class->get_display (context, info, files);
739 * g_app_launch_context_get_startup_notify_id:
740 * @context: a #GAppLaunchContext
742 * @files: a #GList of of #GFile objects
744 * Initiates startup notification for the application and returns the
745 * DESKTOP_STARTUP_ID for the launched operation, if supported.
747 * Startup notification IDs are defined in the <ulink
748 * url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
749 * FreeDesktop.Org Startup Notifications standard</ulink>.
751 * Returns: a startup notification ID for the application, or %NULL if
755 g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
759 GAppLaunchContextClass *class;
761 g_return_val_if_fail (G_IS_APP_LAUNCH_CONTEXT (context), NULL);
762 g_return_val_if_fail (G_IS_APP_INFO (info), NULL);
764 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
766 if (class->get_startup_notify_id == NULL)
769 return class->get_startup_notify_id (context, info, files);
774 * g_app_launch_context_launch_failed:
775 * @context: a #GAppLaunchContext.
776 * @startup_notify_id: the startup notification id that was returned by g_app_launch_context_get_startup_notify_id().
778 * Called when an application has failed to launch, so that it can cancel
779 * the application startup notification started in g_app_launch_context_get_startup_notify_id().
783 g_app_launch_context_launch_failed (GAppLaunchContext *context,
784 const char *startup_notify_id)
786 GAppLaunchContextClass *class;
788 g_return_if_fail (G_IS_APP_LAUNCH_CONTEXT (context));
789 g_return_if_fail (startup_notify_id != NULL);
791 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
793 if (class->launch_failed != NULL)
794 class->launch_failed (context, startup_notify_id);
798 #define __G_APP_INFO_C__
799 #include "gioaliasdef.c"