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>
32 * @short_description: Application information and launch contexts
35 * #GAppInfo and #GAppLaunchContext are used for describing and launching
36 * applications installed on the system.
38 * As of GLib 2.20, URIs will always be converted to POSIX paths
39 * (using g_file_get_path()) when using g_app_info_launch() even if
40 * the application requested an URI and not a POSIX path. For example
41 * for an desktop-file based application with Exec key <literal>totem
42 * %%U</literal> and a single URI,
43 * <literal>sftp://foo/file.avi</literal>, then
44 * <literal>/home/user/.gvfs/sftp on foo/file.avi</literal> will be
45 * passed. This will only work if a set of suitable GIO extensions
46 * (such as gvfs 2.26 compiled with FUSE support), is available and
47 * operational; if this is not the case, the URI will be passed
48 * unmodified to the application. Some URIs, such as
49 * <literal>mailto:</literal>, of course cannot be mapped to a POSIX
50 * path (in gvfs there's no FUSE mount for it); such URIs will be
51 * passed unmodified to the application.
53 * Specifically for gvfs 2.26 and later, the POSIX URI will be mapped
54 * back to the GIO URI in the #GFile constructors (since gvfs
55 * implements the #GVfs extension point). As such, if the application
56 * needs to examine the URI, it needs to use g_file_get_uri() or
57 * similar on #GFile. In other words, an application cannot assume
58 * that the URI passed to e.g. g_file_new_for_commandline_arg() is
59 * equal to the result of g_file_get_uri(). The following snippet
66 * file = g_file_new_for_commandline_arg (uri_from_commandline);
68 * uri = g_file_get_uri (file);
69 * strcmp (uri, uri_from_commandline) == 0; // FALSE
72 * if (g_file_has_uri_scheme (file, "cdda"))
74 * // do something special with uri
76 * g_object_unref (file);
79 * This code will work when both <literal>cdda://sr0/Track
80 * 1.wav</literal> and <literal>/home/user/.gvfs/cdda on sr0/Track
81 * 1.wav</literal> is passed to the application. It should be noted
82 * that it's generally not safe for applications to rely on the format
83 * of a particular URIs. Different launcher applications (e.g. file
84 * managers) may have different ideas of what a given URI means.
88 typedef GAppInfoIface GAppInfoInterface;
89 G_DEFINE_INTERFACE (GAppInfo, g_app_info, G_TYPE_OBJECT)
92 g_app_info_default_init (GAppInfoInterface *iface)
99 * @appinfo: a #GAppInfo.
101 * Creates a duplicate of a #GAppInfo.
103 * Returns: (transfer full): a duplicate of @appinfo.
106 g_app_info_dup (GAppInfo *appinfo)
108 GAppInfoIface *iface;
110 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
112 iface = G_APP_INFO_GET_IFACE (appinfo);
114 return (* iface->dup) (appinfo);
119 * @appinfo1: the first #GAppInfo.
120 * @appinfo2: the second #GAppInfo.
122 * Checks if two #GAppInfo<!-- -->s are equal.
124 * Returns: %TRUE if @appinfo1 is equal to @appinfo2. %FALSE otherwise.
127 g_app_info_equal (GAppInfo *appinfo1,
130 GAppInfoIface *iface;
132 g_return_val_if_fail (G_IS_APP_INFO (appinfo1), FALSE);
133 g_return_val_if_fail (G_IS_APP_INFO (appinfo2), FALSE);
135 if (G_TYPE_FROM_INSTANCE (appinfo1) != G_TYPE_FROM_INSTANCE (appinfo2))
138 iface = G_APP_INFO_GET_IFACE (appinfo1);
140 return (* iface->equal) (appinfo1, appinfo2);
145 * @appinfo: a #GAppInfo.
147 * Gets the ID of an application. An id is a string that
148 * identifies the application. The exact format of the id is
149 * platform dependent. For instance, on Unix this is the
150 * desktop file id from the xdg menu specification.
152 * Note that the returned ID may be %NULL, depending on how
153 * the @appinfo has been constructed.
155 * Returns: a string containing the application's ID.
158 g_app_info_get_id (GAppInfo *appinfo)
160 GAppInfoIface *iface;
162 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
164 iface = G_APP_INFO_GET_IFACE (appinfo);
166 return (* iface->get_id) (appinfo);
170 * g_app_info_get_name:
171 * @appinfo: a #GAppInfo.
173 * Gets the installed name of the application.
175 * Returns: the name of the application for @appinfo.
178 g_app_info_get_name (GAppInfo *appinfo)
180 GAppInfoIface *iface;
182 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
184 iface = G_APP_INFO_GET_IFACE (appinfo);
186 return (* iface->get_name) (appinfo);
190 * g_app_info_get_display_name:
191 * @appinfo: a #GAppInfo.
193 * Gets the display name of the application. The display name is often more
194 * descriptive to the user than the name itself.
196 * Returns: the display name of the application for @appinfo, or the name if
197 * no display name is available.
202 g_app_info_get_display_name (GAppInfo *appinfo)
204 GAppInfoIface *iface;
206 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
208 iface = G_APP_INFO_GET_IFACE (appinfo);
210 if (iface->get_display_name == NULL)
211 return (* iface->get_name) (appinfo);
213 return (* iface->get_display_name) (appinfo);
217 * g_app_info_get_description:
218 * @appinfo: a #GAppInfo.
220 * Gets a human-readable description of an installed application.
222 * Returns: a string containing a description of the
223 * application @appinfo, or %NULL if none.
226 g_app_info_get_description (GAppInfo *appinfo)
228 GAppInfoIface *iface;
230 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
232 iface = G_APP_INFO_GET_IFACE (appinfo);
234 return (* iface->get_description) (appinfo);
238 * g_app_info_get_executable:
239 * @appinfo: a #GAppInfo
241 * Gets the executable's name for the installed application.
243 * Returns: a string containing the @appinfo's application
247 g_app_info_get_executable (GAppInfo *appinfo)
249 GAppInfoIface *iface;
251 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
253 iface = G_APP_INFO_GET_IFACE (appinfo);
255 return (* iface->get_executable) (appinfo);
260 * g_app_info_get_commandline:
261 * @appinfo: a #GAppInfo
263 * Gets the commandline with which the application will be
266 * Returns: a string containing the @appinfo's commandline,
267 * or %NULL if this information is not available
272 g_app_info_get_commandline (GAppInfo *appinfo)
274 GAppInfoIface *iface;
276 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
278 iface = G_APP_INFO_GET_IFACE (appinfo);
280 if (iface->get_commandline)
281 return (* iface->get_commandline) (appinfo);
287 * g_app_info_set_as_default_for_type:
288 * @appinfo: a #GAppInfo.
289 * @content_type: the content type.
292 * Sets the application as the default handler for a given type.
294 * Returns: %TRUE on success, %FALSE on error.
297 g_app_info_set_as_default_for_type (GAppInfo *appinfo,
298 const char *content_type,
301 GAppInfoIface *iface;
303 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
304 g_return_val_if_fail (content_type != NULL, FALSE);
306 iface = G_APP_INFO_GET_IFACE (appinfo);
308 return (* iface->set_as_default_for_type) (appinfo, content_type, error);
312 * g_app_info_set_as_last_used_for_type:
313 * @appinfo: a #GAppInfo.
314 * @content_type: the content type.
317 * Sets the application as the last used application for a given type.
318 * This will make the application appear as first in the list returned by
319 * #g_app_info_get_recommended_for_type, regardless of the default application
320 * for that content type.
322 * Returns: %TRUE on success, %FALSE on error.
325 g_app_info_set_as_last_used_for_type (GAppInfo *appinfo,
326 const char *content_type,
329 GAppInfoIface *iface;
331 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
332 g_return_val_if_fail (content_type != NULL, FALSE);
334 iface = G_APP_INFO_GET_IFACE (appinfo);
336 return (* iface->set_as_last_used_for_type) (appinfo, content_type, error);
340 * g_app_info_set_as_default_for_extension:
341 * @appinfo: a #GAppInfo.
342 * @extension: a string containing the file extension (without the dot).
345 * Sets the application as the default handler for the given file extension.
347 * Returns: %TRUE on success, %FALSE on error.
350 g_app_info_set_as_default_for_extension (GAppInfo *appinfo,
351 const char *extension,
354 GAppInfoIface *iface;
356 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
357 g_return_val_if_fail (extension != NULL, FALSE);
359 iface = G_APP_INFO_GET_IFACE (appinfo);
361 if (iface->set_as_default_for_extension)
362 return (* iface->set_as_default_for_extension) (appinfo, extension, error);
364 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
365 "g_app_info_set_as_default_for_extension not supported yet");
371 * g_app_info_add_supports_type:
372 * @appinfo: a #GAppInfo.
373 * @content_type: a string.
376 * Adds a content type to the application information to indicate the
377 * application is capable of opening files with the given content type.
379 * Returns: %TRUE on success, %FALSE on error.
382 g_app_info_add_supports_type (GAppInfo *appinfo,
383 const char *content_type,
386 GAppInfoIface *iface;
388 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
389 g_return_val_if_fail (content_type != NULL, FALSE);
391 iface = G_APP_INFO_GET_IFACE (appinfo);
393 if (iface->add_supports_type)
394 return (* iface->add_supports_type) (appinfo, content_type, error);
396 g_set_error_literal (error, G_IO_ERROR,
397 G_IO_ERROR_NOT_SUPPORTED,
398 "g_app_info_add_supports_type not supported yet");
405 * g_app_info_can_remove_supports_type:
406 * @appinfo: a #GAppInfo.
408 * Checks if a supported content type can be removed from an application.
410 * Returns: %TRUE if it is possible to remove supported
411 * content types from a given @appinfo, %FALSE if not.
414 g_app_info_can_remove_supports_type (GAppInfo *appinfo)
416 GAppInfoIface *iface;
418 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
420 iface = G_APP_INFO_GET_IFACE (appinfo);
422 if (iface->can_remove_supports_type)
423 return (* iface->can_remove_supports_type) (appinfo);
430 * g_app_info_remove_supports_type:
431 * @appinfo: a #GAppInfo.
432 * @content_type: a string.
435 * Removes a supported type from an application, if possible.
437 * Returns: %TRUE on success, %FALSE on error.
440 g_app_info_remove_supports_type (GAppInfo *appinfo,
441 const char *content_type,
444 GAppInfoIface *iface;
446 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
447 g_return_val_if_fail (content_type != NULL, FALSE);
449 iface = G_APP_INFO_GET_IFACE (appinfo);
451 if (iface->remove_supports_type)
452 return (* iface->remove_supports_type) (appinfo, content_type, error);
454 g_set_error_literal (error, G_IO_ERROR,
455 G_IO_ERROR_NOT_SUPPORTED,
456 "g_app_info_remove_supports_type not supported yet");
463 * g_app_info_get_icon:
464 * @appinfo: a #GAppInfo.
466 * Gets the icon for the application.
468 * Returns: (transfer none): the default #GIcon for @appinfo.
471 g_app_info_get_icon (GAppInfo *appinfo)
473 GAppInfoIface *iface;
475 g_return_val_if_fail (G_IS_APP_INFO (appinfo), NULL);
477 iface = G_APP_INFO_GET_IFACE (appinfo);
479 return (* iface->get_icon) (appinfo);
485 * @appinfo: a #GAppInfo
486 * @files: (element-type GFile): a #GList of #GFile objects
487 * @launch_context: (allow-none): a #GAppLaunchContext or %NULL
490 * Launches the application. Passes @files to the launched application
491 * as arguments, using the optional @launch_context to get information
492 * about the details of the launcher (like what screen it is on).
493 * On error, @error will be set accordingly.
495 * To launch the application without arguments pass a %NULL @files list.
497 * Note that even if the launch is successful the application launched
498 * can fail to start if it runs into problems during startup. There is
499 * no way to detect this.
501 * Some URIs can be changed when passed through a GFile (for instance
502 * unsupported uris with strange formats like mailto:), so if you have
503 * a textual uri you want to pass in as argument, consider using
504 * g_app_info_launch_uris() instead.
506 * On UNIX, this function sets the <envar>GIO_LAUNCHED_DESKTOP_FILE</envar>
507 * environment variable with the path of the launched desktop file and
508 * <envar>GIO_LAUNCHED_DESKTOP_FILE_PID</envar> to the process
509 * id of the launched process. This can be used to ignore
510 * <envar>GIO_LAUNCHED_DESKTOP_FILE</envar>, should it be inherited
511 * by further processes. The <envar>DISPLAY</envar> and
512 * <envar>DESKTOP_STARTUP_ID</envar> environment variables are also
513 * set, based on information provided in @launch_context.
515 * Returns: %TRUE on successful launch, %FALSE otherwise.
518 g_app_info_launch (GAppInfo *appinfo,
520 GAppLaunchContext *launch_context,
523 GAppInfoIface *iface;
525 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
527 iface = G_APP_INFO_GET_IFACE (appinfo);
529 return (* iface->launch) (appinfo, files, launch_context, error);
534 * g_app_info_supports_uris:
535 * @appinfo: a #GAppInfo.
537 * Checks if the application supports reading files and directories from URIs.
539 * Returns: %TRUE if the @appinfo supports URIs.
542 g_app_info_supports_uris (GAppInfo *appinfo)
544 GAppInfoIface *iface;
546 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
548 iface = G_APP_INFO_GET_IFACE (appinfo);
550 return (* iface->supports_uris) (appinfo);
555 * g_app_info_supports_files:
556 * @appinfo: a #GAppInfo.
558 * Checks if the application accepts files as arguments.
560 * Returns: %TRUE if the @appinfo supports files.
563 g_app_info_supports_files (GAppInfo *appinfo)
565 GAppInfoIface *iface;
567 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
569 iface = G_APP_INFO_GET_IFACE (appinfo);
571 return (* iface->supports_files) (appinfo);
576 * g_app_info_launch_uris:
577 * @appinfo: a #GAppInfo
578 * @uris: (element-type utf8): a #GList containing URIs to launch.
579 * @launch_context: (allow-none): a #GAppLaunchContext or %NULL
582 * Launches the application. Passes @uris to the launched application
583 * as arguments, using the optional @launch_context to get information
584 * about the details of the launcher (like what screen it is on).
585 * On error, @error will be set accordingly.
587 * To lauch the application without arguments pass a %NULL @uris list.
589 * Note that even if the launch is successful the application launched
590 * can fail to start if it runs into problems during startup. There is
591 * no way to detect this.
593 * Returns: %TRUE on successful launch, %FALSE otherwise.
596 g_app_info_launch_uris (GAppInfo *appinfo,
598 GAppLaunchContext *launch_context,
601 GAppInfoIface *iface;
603 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
605 iface = G_APP_INFO_GET_IFACE (appinfo);
607 return (* iface->launch_uris) (appinfo, uris, launch_context, error);
612 * g_app_info_should_show:
613 * @appinfo: a #GAppInfo.
615 * Checks if the application info should be shown in menus that
616 * list available applications.
618 * Returns: %TRUE if the @appinfo should be shown, %FALSE otherwise.
621 g_app_info_should_show (GAppInfo *appinfo)
623 GAppInfoIface *iface;
625 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
627 iface = G_APP_INFO_GET_IFACE (appinfo);
629 return (* iface->should_show) (appinfo);
633 * g_app_info_launch_default_for_uri:
634 * @uri: the uri to show
635 * @launch_context: (allow-none): an optional #GAppLaunchContext.
638 * Utility function that launches the default application
639 * registered to handle the specified uri. Synchronous I/O
640 * is done on the uri to detect the type of the file if
643 * Returns: %TRUE on success, %FALSE on error.
646 g_app_info_launch_default_for_uri (const char *uri,
647 GAppLaunchContext *launch_context,
655 file = g_file_new_for_uri (uri);
656 app_info = g_file_query_default_handler (file, NULL, error);
657 g_object_unref (file);
658 if (app_info == NULL)
661 /* Use the uri, not the GFile, as the GFile roundtrip may
662 * affect the uri which we don't want (for instance for a
665 l.data = (char *)uri;
666 l.next = l.prev = NULL;
667 res = g_app_info_launch_uris (app_info, &l,
668 launch_context, error);
670 g_object_unref (app_info);
676 * g_app_info_can_delete:
677 * @appinfo: a #GAppInfo
679 * Obtains the information whether the #GAppInfo can be deleted.
680 * See g_app_info_delete().
682 * Returns: %TRUE if @appinfo can be deleted
687 g_app_info_can_delete (GAppInfo *appinfo)
689 GAppInfoIface *iface;
691 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
693 iface = G_APP_INFO_GET_IFACE (appinfo);
695 if (iface->can_delete)
696 return (* iface->can_delete) (appinfo);
704 * @appinfo: a #GAppInfo
706 * Tries to delete a #GAppInfo.
708 * On some platforms, there may be a difference between user-defined
709 * #GAppInfo<!-- -->s which can be deleted, and system-wide ones which
710 * cannot. See g_app_info_can_delete().
713 * Returns: %TRUE if @appinfo has been deleted
718 g_app_info_delete (GAppInfo *appinfo)
720 GAppInfoIface *iface;
722 g_return_val_if_fail (G_IS_APP_INFO (appinfo), FALSE);
724 iface = G_APP_INFO_GET_IFACE (appinfo);
726 if (iface->do_delete)
727 return (* iface->do_delete) (appinfo);
733 G_DEFINE_TYPE (GAppLaunchContext, g_app_launch_context, G_TYPE_OBJECT);
736 * g_app_launch_context_new:
738 * Creates a new application launch context. This is not normally used,
739 * instead you instantiate a subclass of this, such as #GdkAppLaunchContext.
741 * Returns: a #GAppLaunchContext.
744 g_app_launch_context_new (void)
746 return g_object_new (G_TYPE_APP_LAUNCH_CONTEXT, NULL);
750 g_app_launch_context_class_init (GAppLaunchContextClass *klass)
755 g_app_launch_context_init (GAppLaunchContext *launch_context)
760 * g_app_launch_context_get_display:
761 * @context: a #GAppLaunchContext
763 * @files: (element-type GFile): a #GList of #GFile objects
765 * Gets the display string for the @context. This is used to ensure new
766 * applications are started on the same display as the launching
767 * application, by setting the <envar>DISPLAY</envar> environment variable.
769 * Returns: a display string for the display.
772 g_app_launch_context_get_display (GAppLaunchContext *context,
776 GAppLaunchContextClass *class;
778 g_return_val_if_fail (G_IS_APP_LAUNCH_CONTEXT (context), NULL);
779 g_return_val_if_fail (G_IS_APP_INFO (info), NULL);
781 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
783 if (class->get_display == NULL)
786 return class->get_display (context, info, files);
790 * g_app_launch_context_get_startup_notify_id:
791 * @context: a #GAppLaunchContext
793 * @files: (element-type GFile): a #GList of of #GFile objects
795 * Initiates startup notification for the application and returns the
796 * <envar>DESKTOP_STARTUP_ID</envar> for the launched operation,
799 * Startup notification IDs are defined in the <ulink
800 * url="http://standards.freedesktop.org/startup-notification-spec/startup-notification-latest.txt">
801 * FreeDesktop.Org Startup Notifications standard</ulink>.
803 * Returns: a startup notification ID for the application, or %NULL if
807 g_app_launch_context_get_startup_notify_id (GAppLaunchContext *context,
811 GAppLaunchContextClass *class;
813 g_return_val_if_fail (G_IS_APP_LAUNCH_CONTEXT (context), NULL);
814 g_return_val_if_fail (G_IS_APP_INFO (info), NULL);
816 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
818 if (class->get_startup_notify_id == NULL)
821 return class->get_startup_notify_id (context, info, files);
826 * g_app_launch_context_launch_failed:
827 * @context: a #GAppLaunchContext.
828 * @startup_notify_id: the startup notification id that was returned by g_app_launch_context_get_startup_notify_id().
830 * Called when an application has failed to launch, so that it can cancel
831 * the application startup notification started in g_app_launch_context_get_startup_notify_id().
835 g_app_launch_context_launch_failed (GAppLaunchContext *context,
836 const char *startup_notify_id)
838 GAppLaunchContextClass *class;
840 g_return_if_fail (G_IS_APP_LAUNCH_CONTEXT (context));
841 g_return_if_fail (startup_notify_id != NULL);
843 class = G_APP_LAUNCH_CONTEXT_GET_CLASS (context);
845 if (class->launch_failed != NULL)
846 class->launch_failed (context, startup_notify_id);