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 #GAppInfo<!-- -->s 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_display_name:
231 * @appinfo: a #GAppInfo.
233 * Gets the display name of the application. The display name is often more
234 * descriptive to the user than the name itself.
236 * Returns: the display name of the application for @appinfo, or the name if
237 * no display name is available.
242 g_app_info_get_display_name (GAppInfo *appinfo)
244 GAppInfoIface *iface;
246 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
248 iface = G_APP_INFO_GET_IFACE (appinfo);
250 if (iface->get_display_name == NULL)
251 return (* iface->get_name) (appinfo);
253 return (* iface->get_display_name) (appinfo);
257 * g_app_info_get_description:
258 * @appinfo: a #GAppInfo.
260 * Gets a human-readable description of an installed application.
262 * Returns: a string containing a description of the
263 * application @appinfo, or %NULL if none.
266 g_app_info_get_description (GAppInfo *appinfo)
268 GAppInfoIface *iface;
270 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
272 iface = G_APP_INFO_GET_IFACE (appinfo);
274 return (* iface->get_description) (appinfo);
278 * g_app_info_get_executable:
279 * @appinfo: a #GAppInfo
281 * Gets the executable's name for the installed application.
283 * Returns: a string containing the @appinfo's application
287 g_app_info_get_executable (GAppInfo *appinfo)
289 GAppInfoIface *iface;
291 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
293 iface = G_APP_INFO_GET_IFACE (appinfo);
295 return (* iface->get_executable) (appinfo);
300 * g_app_info_get_commandline:
301 * @appinfo: a #GAppInfo
303 * Gets the commandline with which the application will be
306 * Returns: a string containing the @appinfo's commandline,
307 * or %NULL if this information is not available
312 g_app_info_get_commandline (GAppInfo *appinfo)
314 GAppInfoIface *iface;
316 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
318 iface = G_APP_INFO_GET_IFACE (appinfo);
320 if (iface->get_commandline)
321 return (* iface->get_commandline) (appinfo);
327 * g_app_info_set_as_default_for_type:
328 * @appinfo: a #GAppInfo.
329 * @content_type: the content type.
332 * Sets the application as the default handler for a given type.
334 * Returns: %TRUE on success, %FALSE on error.
337 g_app_info_set_as_default_for_type (GAppInfo *appinfo,
338 const char *content_type,
341 GAppInfoIface *iface;
343 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
344 g_return_val_if_fail (content_type != NULL, FALSE);
346 iface = G_APP_INFO_GET_IFACE (appinfo);
348 return (* iface->set_as_default_for_type) (appinfo, content_type, error);
353 * g_app_info_set_as_default_for_extension:
354 * @appinfo: a #GAppInfo.
355 * @extension: a string containing the file extension (without the dot).
358 * Sets the application as the default handler for the given file extension.
360 * Returns: %TRUE on success, %FALSE on error.
363 g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
364 const char *extension,
367 GAppInfoIface *iface;
369 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
370 g_return_val_if_fail (extension != NULL, FALSE);
372 iface = G_APP_INFO_GET_IFACE (appinfo);
374 if (iface->set_as_default_for_extension)
375 return (* iface->set_as_default_for_extension) (appinfo, extension, error);
377 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
378 "g_app_info_set_as_default_for_extension not supported yet");
384 * g_app_info_add_supports_type:
385 * @appinfo: a #GAppInfo.
386 * @content_type: a string.
389 * Adds a content type to the application information to indicate the
390 * application is capable of opening files with the given content type.
392 * Returns: %TRUE on success, %FALSE on error.
395 g_app_info_add_supports_type (GAppInfo *appinfo,
396 const char *content_type,
399 GAppInfoIface *iface;
401 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
402 g_return_val_if_fail (content_type != NULL, FALSE);
404 iface = G_APP_INFO_GET_IFACE (appinfo);
406 if (iface->add_supports_type)
407 return (* iface->add_supports_type) (appinfo, content_type, error);
409 g_set_error_literal (error, G_IO_ERROR,
410 G_IO_ERROR_NOT_SUPPORTED,
411 "g_app_info_add_supports_type not supported yet");
418 * g_app_info_can_remove_supports_type:
419 * @appinfo: a #GAppInfo.
421 * Checks if a supported content type can be removed from an application.
423 * Returns: %TRUE if it is possible to remove supported
424 * content types from a given @appinfo, %FALSE if not.
427 g_app_info_can_remove_supports_type (GAppInfo *appinfo)
429 GAppInfoIface *iface;
431 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
433 iface = G_APP_INFO_GET_IFACE (appinfo);
435 if (iface->can_remove_supports_type)
436 return (* iface->can_remove_supports_type) (appinfo);
443 * g_app_info_remove_supports_type:
444 * @appinfo: a #GAppInfo.
445 * @content_type: a string.
448 * Removes a supported type from an application, if possible.
450 * Returns: %TRUE on success, %FALSE on error.
453 g_app_info_remove_supports_type (GAppInfo *appinfo,
454 const char *content_type,
457 GAppInfoIface *iface;
459 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
460 g_return_val_if_fail (content_type != NULL, FALSE);
462 iface = G_APP_INFO_GET_IFACE (appinfo);
464 if (iface->remove_supports_type)
465 return (* iface->remove_supports_type) (appinfo, content_type, error);
467 g_set_error_literal (error, G_IO_ERROR,
468 G_IO_ERROR_NOT_SUPPORTED,
469 "g_app_info_remove_supports_type not supported yet");
476 * g_app_info_get_icon:
477 * @appinfo: a #GAppInfo.
479 * Gets the icon for the application.
481 * Returns: the default #GIcon for @appinfo.
484 g_app_info_get_icon (GAppInfo *appinfo)
486 GAppInfoIface *iface;
488 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
490 iface = G_APP_INFO_GET_IFACE (appinfo);
492 return (* iface->get_icon) (appinfo);
498 * @appinfo: a #GAppInfo
499 * @files: a #GList of #GFile objects
500 * @launch_context: a #GAppLaunchContext or %NULL
503 * Launches the application. Passes @files to the launched application
504 * as arguments, using the optional @launch_context to get information
505 * about the details of the launcher (like what screen it is on).
506 * On error, @error will be set accordingly.
508 * To lauch the application without arguments pass a %NULL @files list.
510 * Note that even if the launch is successful the application launched
511 * can fail to start if it runs into problems during startup. There is
512 * no way to detect this.
514 * Some URIs can be changed when passed through a GFile (for instance
515 * unsupported uris with strange formats like mailto:), so if you have
516 * a textual uri you want to pass in as argument, consider using
517 * g_app_info_launch_uris() instead.
519 * Returns: %TRUE on successful launch, %FALSE otherwise.
522 g_app_info_launch (GAppInfo *appinfo,
524 GAppLaunchContext *launch_context,
527 GAppInfoIface *iface;
529 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
531 iface = G_APP_INFO_GET_IFACE (appinfo);
533 return (* iface->launch) (appinfo, files, launch_context, error);
538 * g_app_info_supports_uris:
539 * @appinfo: a #GAppInfo.
541 * Checks if the application supports reading files and directories from URIs.
543 * Returns: %TRUE if the @appinfo supports URIs.
546 g_app_info_supports_uris (GAppInfo *appinfo)
548 GAppInfoIface *iface;
550 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
552 iface = G_APP_INFO_GET_IFACE (appinfo);
554 return (* iface->supports_uris) (appinfo);
559 * g_app_info_supports_files:
560 * @appinfo: a #GAppInfo.
562 * Checks if the application accepts files as arguments.
564 * Returns: %TRUE if the @appinfo supports files.
567 g_app_info_supports_files (GAppInfo *appinfo)
569 GAppInfoIface *iface;
571 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
573 iface = G_APP_INFO_GET_IFACE (appinfo);
575 return (* iface->supports_files) (appinfo);
580 * g_app_info_launch_uris:
581 * @appinfo: a #GAppInfo
582 * @uris: a #GList containing URIs to launch.
583 * @launch_context: a #GAppLaunchContext or %NULL
586 * Launches the application. Passes @uris to the launched application
587 * as arguments, using the optional @launch_context to get information
588 * about the details of the launcher (like what screen it is on).
589 * On error, @error will be set accordingly.
591 * To lauch the application without arguments pass a %NULL @uris list.
593 * Note that even if the launch is successful the application launched
594 * can fail to start if it runs into problems during startup. There is
595 * no way to detect this.
597 * Returns: %TRUE on successful launch, %FALSE otherwise.
600 g_app_info_launch_uris (GAppInfo *appinfo,
602 GAppLaunchContext *launch_context,
605 GAppInfoIface *iface;
607 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
609 iface = G_APP_INFO_GET_IFACE (appinfo);
611 return (* iface->launch_uris) (appinfo, uris, launch_context, error);
616 * g_app_info_should_show:
617 * @appinfo: a #GAppInfo.
619 * Checks if the application info should be shown in menus that
620 * list available applications.
622 * Returns: %TRUE if the @appinfo should be shown, %FALSE otherwise.
625 g_app_info_should_show (GAppInfo *appinfo)
627 GAppInfoIface *iface;
629 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
631 iface = G_APP_INFO_GET_IFACE (appinfo);
633 return (* iface->should_show) (appinfo);
637 * g_app_info_launch_default_for_uri:
638 * @uri: the uri to show
639 * @launch_context: an optional #GAppLaunchContext.
642 * Utility function that launches the default application
643 * registered to handle the specified uri. Synchronous I/O
644 * is done on the uri to detect the type of the file if
647 * Returns: %TRUE on success, %FALSE on error.
650 g_app_info_launch_default_for_uri (const char *uri,
651 GAppLaunchContext *launch_context,
659 file = g_file_new_for_uri (uri);
660 app_info = g_file_query_default_handler (file, NULL, error);
661 g_object_unref (file);
662 if (app_info == NULL)
665 /* Use the uri, not the GFile, as the GFile roundtrip may
666 * affect the uri which we don't want (for instance for a
669 l.data = (char *)uri;
670 l.next = l.prev = NULL;
671 res = g_app_info_launch_uris (app_info, &l,
672 launch_context, error);
674 g_object_unref (app_info);
680 * g_app_info_can_delete:
681 * @appinfo: a #GAppInfo
683 * Obtains the information whether the #GAppInfo can be deleted.
684 * See g_app_info_delete().
686 * Returns: %TRUE if @appinfo can be deleted
691 g_app_info_can_delete (GAppInfo *appinfo)
693 GAppInfoIface *iface;
695 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
697 iface = G_APP_INFO_GET_IFACE (appinfo);
699 if (iface->can_delete)
700 return (* iface->can_delete) (appinfo);
708 * @appinfo: a #GAppInfo
710 * Tries to delete a #GAppInfo.
712 * On some platforms, there may be a difference between user-defined
713 * #GAppInfo<!-- -->s which can be deleted, and system-wide ones which
714 * cannot. See g_app_info_can_delete().
716 * Returns: %TRUE if @appinfo has been deleted
721 g_app_info_delete (GAppInfo *appinfo)
723 GAppInfoIface *iface;
725 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
727 iface = G_APP_INFO_GET_IFACE (appinfo);
729 if (iface->do_delete)
730 return (* iface->do_delete) (appinfo);
736 G_DEFINE_TYPE (GAppLaunchContext, g_app_launch_context, G_TYPE_OBJECT);
739 * g_app_launch_context_new:
741 * Creates a new application launch context. This is not normally used,
742 * instead you instantiate a subclass of this, such as #GdkAppLaunchContext.
744 * Returns: a #GAppLaunchContext.
747 g_app_launch_context_new (void)
749 return g_object_new (G_TYPE_APP_LAUNCH_CONTEXT, NULL);
753 g_app_launch_context_class_init (GAppLaunchContextClass *klass)
758 g_app_launch_context_init (GAppLaunchContext *launch_context)
763 * g_app_launch_context_get_display:
764 * @context: a #GAppLaunchContext
766 * @files: a #GList of #GFile objects
768 * Gets the display string for the display. This is used to ensure new
769 * applications are started on the same display as the launching
772 * Returns: a display string for the display.
775 g_app_launch_context_get_display (GAppLaunchContext *context,
779 GAppLaunchContextClass *class;
781 g_return_val_if_fail (G_IS_APP_LAUNCH_CONTEXT (context), NULL);
782 g_return_val_if_fail (G_IS_APP_INFO (info), NULL);
784 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
786 if (class->get_display == NULL)
789 return class->get_display (context, info, files);
793 * g_app_launch_context_get_startup_notify_id:
794 * @context: a #GAppLaunchContext
796 * @files: a #GList of of #GFile objects
798 * Initiates startup notification for the application and returns the
799 * DESKTOP_STARTUP_ID for the launched operation, if supported.
801 * Startup notification IDs are defined in the <ulink
802 * url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
803 * FreeDesktop.Org Startup Notifications standard</ulink>.
805 * Returns: a startup notification ID for the application, or %NULL if
809 g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
813 GAppLaunchContextClass *class;
815 g_return_val_if_fail (G_IS_APP_LAUNCH_CONTEXT (context), NULL);
816 g_return_val_if_fail (G_IS_APP_INFO (info), NULL);
818 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
820 if (class->get_startup_notify_id == NULL)
823 return class->get_startup_notify_id (context, info, files);
828 * g_app_launch_context_launch_failed:
829 * @context: a #GAppLaunchContext.
830 * @startup_notify_id: the startup notification id that was returned by g_app_launch_context_get_startup_notify_id().
832 * Called when an application has failed to launch, so that it can cancel
833 * the application startup notification started in g_app_launch_context_get_startup_notify_id().
837 g_app_launch_context_launch_failed (GAppLaunchContext *context,
838 const char *startup_notify_id)
840 GAppLaunchContextClass *class;
842 g_return_if_fail (G_IS_APP_LAUNCH_CONTEXT (context));
843 g_return_if_fail (startup_notify_id != NULL);
845 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
847 if (class->launch_failed != NULL)
848 class->launch_failed (context, startup_notify_id);
852 #define __G_APP_INFO_C__
853 #include "gioaliasdef.c"