1 /* GDBus - GLib D-Bus Library
3 * Copyright (C) 2008-2009 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: David Zeuthen <davidz@redhat.com>
27 #include <glib/gi18n.h>
29 #include "gdbuserror.h"
31 #include "gioenumtypes.h"
33 #include "gdbusprivate.h"
38 * @short_description: Mapping D-Bus errors to and from #GError
39 * @include: gdbus/gdbus.h
41 * All facilities that return errors from remote methods (such as
42 * g_dbus_connection_invoke_method_sync()) use #GError to represent
43 * both D-Bus errors (e.g. errors returned from the other peer) and
44 * locally in-process generated errors.
46 * To check if a returned #GError is an error from a remote peer, use
47 * g_dbus_error_is_remote_error(). To get the actual D-Bus error name,
48 * use g_dbus_error_get_remote_error(). Before presenting an error,
49 * always use g_dbus_error_strip_remote_error().
51 * In addition, facilities used to return errors to a remote peer also
52 * use #GError. See g_dbus_method_invocation_return_error() for
53 * discussion about how the D-Bus error name is set.
55 * Applications can associate a #GError error domain with a set of D-Bus errors in order to
56 * automatically map from D-Bus errors to #GError and back. This
57 * is typically done in the function returning the #GQuark for the
59 * <example id="error-registration"><title>Error Registration</title><programlisting>
60 * /<!-- -->* foo-bar-error.h: *<!-- -->/
62 * #define FOO_BAR_ERROR (foo_bar_error_quark ())
63 * GQuark foo_bar_error_quark (void);
67 * FOO_BAR_ERROR_FAILED,
68 * FOO_BAR_ERROR_ANOTHER_ERROR,
69 * FOO_BAR_ERROR_SOME_THIRD_ERROR,
72 * /<!-- -->* foo-bar-error.c: *<!-- -->/
74 * static const GDBusErrorEntry foo_bar_error_entries[] =
76 * {FOO_BAR_ERROR_FAILED, "org.project.Foo.Bar.Error.Failed"},
77 * {FOO_BAR_ERROR_ANOTHER_ERROR, "org.project.Foo.Bar.Error.AnotherError"},
78 * {FOO_BAR_ERROR_SOME_THIRD_ERROR, "org.project.Foo.Bar.Error.SomeThirdError"},
82 * foo_bar_error_quark (void)
84 * static volatile gsize quark_volatile = 0;
85 * g_dbus_error_register_error_domain ("foo-bar-error-quark",
87 * foo_bar_error_entries,
88 * G_N_ELEMENTS (foo_bar_error_entries));
89 * G_STATIC_ASSERT (G_N_ELEMENTS (foo_bar_error_entries) - 1 == FOO_BAR_ERROR_SOME_THIRD_ERROR);
90 * return (GQuark) quark_volatile;
92 * </programlisting></example>
93 * With this setup, a D-Bus peer can transparently pass e.g. %FOO_BAR_ERROR_ANOTHER_ERROR and
94 * other peers will see the D-Bus error name <literal>org.project.Foo.Bar.Error.AnotherError</literal>.
95 * If the other peer is using GDBus, the peer will see also %FOO_BAR_ERROR_ANOTHER_ERROR instead
96 * of %G_IO_ERROR_DBUS_ERROR. Note that GDBus clients can still recover
97 * <literal>org.project.Foo.Bar.Error.AnotherError</literal> using g_dbus_error_get_remote_error().
99 * Note that errors in the %G_DBUS_ERROR error domain is intended only
100 * for returning errors from a remote message bus process. Errors
101 * generated locally in-process by e.g. #GDBusConnection is from the
102 * %G_IO_ERROR domain.
105 static const GDBusErrorEntry g_dbus_error_entries[] =
107 {G_DBUS_ERROR_FAILED, "org.freedesktop.DBus.Error.Failed"},
108 {G_DBUS_ERROR_NO_MEMORY, "org.freedesktop.DBus.Error.NoMemory"},
109 {G_DBUS_ERROR_SERVICE_UNKNOWN, "org.freedesktop.DBus.Error.ServiceUnknown"},
110 {G_DBUS_ERROR_NAME_HAS_NO_OWNER, "org.freedesktop.DBus.Error.NameHasNoOwner"},
111 {G_DBUS_ERROR_NO_REPLY, "org.freedesktop.DBus.Error.NoReply"},
112 {G_DBUS_ERROR_IO_ERROR, "org.freedesktop.DBus.Error.IOError"},
113 {G_DBUS_ERROR_BAD_ADDRESS, "org.freedesktop.DBus.Error.BadAddress"},
114 {G_DBUS_ERROR_NOT_SUPPORTED, "org.freedesktop.DBus.Error.NotSupported"},
115 {G_DBUS_ERROR_LIMITS_EXCEEDED, "org.freedesktop.DBus.Error.LimitsExceeded"},
116 {G_DBUS_ERROR_ACCESS_DENIED, "org.freedesktop.DBus.Error.AccessDenied"},
117 {G_DBUS_ERROR_AUTH_FAILED, "org.freedesktop.DBus.Error.AuthFailed"},
118 {G_DBUS_ERROR_NO_SERVER, "org.freedesktop.DBus.Error.NoServer"},
119 {G_DBUS_ERROR_TIMEOUT, "org.freedesktop.DBus.Error.Timeout"},
120 {G_DBUS_ERROR_NO_NETWORK, "org.freedesktop.DBus.Error.NoNetwork"},
121 {G_DBUS_ERROR_ADDRESS_IN_USE, "org.freedesktop.DBus.Error.AddressInUse"},
122 {G_DBUS_ERROR_DISCONNECTED, "org.freedesktop.DBus.Error.Disconnected"},
123 {G_DBUS_ERROR_INVALID_ARGS, "org.freedesktop.DBus.Error.InvalidArgs"},
124 {G_DBUS_ERROR_FILE_NOT_FOUND, "org.freedesktop.DBus.Error.FileNotFound"},
125 {G_DBUS_ERROR_FILE_EXISTS, "org.freedesktop.DBus.Error.FileExists"},
126 {G_DBUS_ERROR_UNKNOWN_METHOD, "org.freedesktop.DBus.Error.UnknownMethod"},
127 {G_DBUS_ERROR_TIMED_OUT, "org.freedesktop.DBus.Error.TimedOut"},
128 {G_DBUS_ERROR_MATCH_RULE_NOT_FOUND, "org.freedesktop.DBus.Error.MatchRuleNotFound"},
129 {G_DBUS_ERROR_MATCH_RULE_INVALID, "org.freedesktop.DBus.Error.MatchRuleInvalid"},
130 {G_DBUS_ERROR_SPAWN_EXEC_FAILED, "org.freedesktop.DBus.Error.Spawn.ExecFailed"},
131 {G_DBUS_ERROR_SPAWN_FORK_FAILED, "org.freedesktop.DBus.Error.Spawn.ForkFailed"},
132 {G_DBUS_ERROR_SPAWN_CHILD_EXITED, "org.freedesktop.DBus.Error.Spawn.ChildExited"},
133 {G_DBUS_ERROR_SPAWN_CHILD_SIGNALED, "org.freedesktop.DBus.Error.Spawn.ChildSignaled"},
134 {G_DBUS_ERROR_SPAWN_FAILED, "org.freedesktop.DBus.Error.Spawn.Failed"},
135 {G_DBUS_ERROR_SPAWN_SETUP_FAILED, "org.freedesktop.DBus.Error.Spawn.FailedToSetup"},
136 {G_DBUS_ERROR_SPAWN_CONFIG_INVALID, "org.freedesktop.DBus.Error.Spawn.ConfigInvalid"},
137 {G_DBUS_ERROR_SPAWN_SERVICE_INVALID, "org.freedesktop.DBus.Error.Spawn.ServiceNotValid"},
138 {G_DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND, "org.freedesktop.DBus.Error.Spawn.ServiceNotFound"},
139 {G_DBUS_ERROR_SPAWN_PERMISSIONS_INVALID, "org.freedesktop.DBus.Error.Spawn.PermissionsInvalid"},
140 {G_DBUS_ERROR_SPAWN_FILE_INVALID, "org.freedesktop.DBus.Error.Spawn.FileInvalid"},
141 {G_DBUS_ERROR_SPAWN_NO_MEMORY, "org.freedesktop.DBus.Error.Spawn.NoMemory"},
142 {G_DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN, "org.freedesktop.DBus.Error.UnixProcessIdUnknown"},
143 {G_DBUS_ERROR_INVALID_SIGNATURE, "org.freedesktop.DBus.Error.InvalidSignature"},
144 {G_DBUS_ERROR_INVALID_FILE_CONTENT, "org.freedesktop.DBus.Error.InvalidFileContent"},
145 {G_DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN, "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown"},
146 {G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN, "org.freedesktop.DBus.Error.AdtAuditDataUnknown"},
147 {G_DBUS_ERROR_OBJECT_PATH_IN_USE, "org.freedesktop.DBus.Error.ObjectPathInUse"},
151 g_dbus_error_quark (void)
153 static volatile gsize quark_volatile = 0;
154 g_dbus_error_register_error_domain ("g-dbus-error-quark",
156 g_dbus_error_entries,
157 G_N_ELEMENTS (g_dbus_error_entries));
158 G_STATIC_ASSERT (G_N_ELEMENTS (g_dbus_error_entries) - 1 == G_DBUS_ERROR_OBJECT_PATH_IN_USE);
159 return (GQuark) quark_volatile;
163 * g_dbus_error_register_error_domain:
164 * @error_domain_quark_name: The error domain name.
165 * @quark_volatile: A pointer where to store the #GQuark.
166 * @entries: A pointer to @num_entries #GDBusErrorEntry struct items.
167 * @num_entries: Number of items to register.
169 * Helper function for associating a #GError error domain with D-Bus error names.
172 g_dbus_error_register_error_domain (const gchar *error_domain_quark_name,
173 volatile gsize *quark_volatile,
174 const GDBusErrorEntry *entries,
177 g_return_if_fail (error_domain_quark_name != NULL);
178 g_return_if_fail (quark_volatile != NULL);
179 g_return_if_fail (entries != NULL);
180 g_return_if_fail (num_entries > 0);
182 if (g_once_init_enter (quark_volatile))
187 quark = g_quark_from_static_string (error_domain_quark_name);
189 for (n = 0; n < num_entries; n++)
191 g_warn_if_fail (g_dbus_error_register_error (quark,
192 entries[n].error_code,
193 entries[n].dbus_error_name));
195 g_once_init_leave (quark_volatile, quark);
200 _g_dbus_error_decode_gerror (const gchar *dbus_name,
201 GQuark *out_error_domain,
202 gint *out_error_code)
207 gchar *domain_quark_string;
212 if (g_str_has_prefix (dbus_name, "org.gtk.GDBus.UnmappedGError.Quark._"))
214 s = g_string_new (NULL);
216 for (n = sizeof "org.gtk.GDBus.UnmappedGError.Quark._" - 1;
217 dbus_name[n] != '.' && dbus_name[n] != '\0';
220 if (g_ascii_isalnum (dbus_name[n]))
222 g_string_append_c (s, dbus_name[n]);
224 else if (dbus_name[n] == '_')
231 nibble_top = dbus_name[n];
232 if (nibble_top >= '0' && nibble_top <= '9')
234 else if (nibble_top >= 'a' && nibble_top <= 'f')
235 nibble_top -= ('a' - 10);
241 nibble_bottom = dbus_name[n];
242 if (nibble_bottom >= '0' && nibble_bottom <= '9')
243 nibble_bottom -= '0';
244 else if (nibble_bottom >= 'a' && nibble_bottom <= 'f')
245 nibble_bottom -= ('a' - 10);
249 g_string_append_c (s, (nibble_top<<4) | nibble_bottom);
257 if (!g_str_has_prefix (dbus_name + n, ".Code"))
260 domain_quark_string = g_string_free (s, FALSE);
263 if (out_error_domain != NULL)
264 *out_error_domain = g_quark_from_string (domain_quark_string);
265 g_free (domain_quark_string);
267 if (out_error_code != NULL)
268 *out_error_code = atoi (dbus_name + n + sizeof ".Code" - 1);
276 g_string_free (s, TRUE);
281 /* ---------------------------------------------------------------------------------------------------- */
290 quark_code_pair_hash_func (const QuarkCodePair *pair)
293 val = pair->error_domain + pair->error_code;
294 return g_int_hash (&val);
298 quark_code_pair_equal_func (const QuarkCodePair *a,
299 const QuarkCodePair *b)
301 return (a->error_domain == b->error_domain) && (a->error_code == b->error_code);
307 gchar *dbus_error_name;
311 registered_error_free (RegisteredError *re)
313 g_free (re->dbus_error_name);
317 G_LOCK_DEFINE_STATIC (error_lock);
319 /* maps from QuarkCodePair* -> RegisteredError* */
320 static GHashTable *quark_code_pair_to_re = NULL;
322 /* maps from gchar* -> RegisteredError* */
323 static GHashTable *dbus_error_name_to_re = NULL;
326 * g_dbus_error_register_error:
327 * @error_domain: A #GQuark for a error domain.
328 * @error_code: An error code.
329 * @dbus_error_name: A D-Bus error name.
331 * Creates an association to map between @dbus_error_name and
332 * #GError<!-- -->s specified by @error_domain and @error_code.
334 * This is typically done in the routine that returns the #GQuark for
337 * Returns: %TRUE if the association was created, %FALSE if it already
341 g_dbus_error_register_error (GQuark error_domain,
343 const gchar *dbus_error_name)
349 g_return_val_if_fail (dbus_error_name != NULL, FALSE);
355 if (quark_code_pair_to_re == NULL)
357 g_assert (dbus_error_name_to_re == NULL); /* check invariant */
358 quark_code_pair_to_re = g_hash_table_new ((GHashFunc) quark_code_pair_hash_func,
359 (GEqualFunc) quark_code_pair_equal_func);
360 dbus_error_name_to_re = g_hash_table_new_full (g_str_hash,
363 (GDestroyNotify) registered_error_free);
366 if (g_hash_table_lookup (dbus_error_name_to_re, dbus_error_name) != NULL)
369 pair.error_domain = error_domain;
370 pair.error_code = error_code;
372 if (g_hash_table_lookup (quark_code_pair_to_re, &pair) != NULL)
375 re = g_new0 (RegisteredError, 1);
377 re->dbus_error_name = g_strdup (dbus_error_name);
379 g_hash_table_insert (quark_code_pair_to_re, &(re->pair), re);
380 g_hash_table_insert (dbus_error_name_to_re, re->dbus_error_name, re);
385 G_UNLOCK (error_lock);
390 * g_dbus_error_unregister_error:
391 * @error_domain: A #GQuark for a error domain.
392 * @error_code: An error code.
393 * @dbus_error_name: A D-Bus error name.
395 * Destroys an association previously set up with g_dbus_error_register_error().
397 * Returns: %TRUE if the association was destroyed, %FALSE if it wasn't found.
400 g_dbus_error_unregister_error (GQuark error_domain,
402 const gchar *dbus_error_name)
408 g_return_val_if_fail (dbus_error_name != NULL, FALSE);
414 if (dbus_error_name_to_re == NULL)
416 g_assert (quark_code_pair_to_re == NULL); /* check invariant */
420 re = g_hash_table_lookup (dbus_error_name_to_re, dbus_error_name);
424 pair.error_domain = error_domain;
425 pair.error_code = error_code;
426 g_warn_if_fail (g_hash_table_lookup (quark_code_pair_to_re, &pair) == NULL); /* check invariant */
429 g_warn_if_fail (g_hash_table_lookup (quark_code_pair_to_re, &(re->pair)) == re); /* check invariant */
431 g_warn_if_fail (g_hash_table_remove (quark_code_pair_to_re, &(re->pair)));
432 g_warn_if_fail (g_hash_table_remove (dbus_error_name_to_re, re));
434 /* destroy hashes if empty */
435 hash_size = g_hash_table_size (dbus_error_name_to_re);
438 g_warn_if_fail (g_hash_table_size (quark_code_pair_to_re) == 0); /* check invariant */
440 g_hash_table_unref (dbus_error_name_to_re);
441 dbus_error_name_to_re = NULL;
442 g_hash_table_unref (quark_code_pair_to_re);
443 quark_code_pair_to_re = NULL;
447 g_warn_if_fail (g_hash_table_size (quark_code_pair_to_re) == hash_size); /* check invariant */
451 G_UNLOCK (error_lock);
455 /* ---------------------------------------------------------------------------------------------------- */
458 * g_dbus_error_is_remote_error:
461 * Checks if @error represents an error received via D-Bus from a remote peer. If so,
462 * use g_dbus_error_get_remote_error() to get the name of the error.
464 * Returns: %TRUE if @error represents an error from a remote peer,
468 g_dbus_error_is_remote_error (const GError *error)
470 g_return_val_if_fail (error != NULL, FALSE);
471 return g_str_has_prefix (error->message, "GDBus.Error:");
476 * g_dbus_error_get_remote_error:
479 * Gets the D-Bus error name used for @error, if any.
481 * This function is guaranteed to return a D-Bus error name for all #GError<!-- -->s returned from
482 * functions handling remote method calls (e.g. g_dbus_connection_invoke_method_finish())
483 * unless g_dbus_error_strip_remote_error() has been used on @error.
485 * Returns: An allocated string or %NULL if the D-Bus error name could not be found. Free with g_free().
488 g_dbus_error_get_remote_error (const GError *error)
493 g_return_val_if_fail (error != NULL, NULL);
495 /* Ensure that e.g. G_DBUS_ERROR is registered using g_dbus_error_register_error() */
496 _g_dbus_initialize ();
503 if (quark_code_pair_to_re != NULL)
506 pair.error_domain = error->domain;
507 pair.error_code = error->code;
508 g_assert (dbus_error_name_to_re != NULL); /* check invariant */
509 re = g_hash_table_lookup (quark_code_pair_to_re, &pair);
514 ret = g_strdup (re->dbus_error_name);
518 if (g_str_has_prefix (error->message, "GDBus.Error:"))
522 begin = error->message + sizeof ("GDBus.Error:") -1;
523 end = strstr (begin, ":");
524 if (end != NULL && end[1] == ' ')
526 ret = g_strndup (begin, end - begin);
531 G_UNLOCK (error_lock);
536 /* ---------------------------------------------------------------------------------------------------- */
539 * g_dbus_error_new_for_dbus_error:
540 * @dbus_error_name: D-Bus error name.
541 * @dbus_error_message: D-Bus error message.
543 * Creates a #GError based on the contents of @dbus_error_name and
544 * @dbus_error_message.
546 * Errors registered with g_dbus_error_register_error() will be looked
547 * up using @dbus_error_name and if a match is found, the error domain
548 * and code is used. Applications can use g_dbus_error_get_remote_error()
549 * to recover @dbus_error_name.
551 * If a match against a registered error is not found and the D-Bus
552 * error name is in a form as returned by g_dbus_error_encode_gerror()
553 * the error domain and code encoded in the name is used to
554 * create the #GError. Also, @dbus_error_name is added to the error message
555 * such that it can be recovered with g_dbus_error_get_remote_error().
557 * Otherwise, a #GError with the error code %G_IO_ERROR_DBUS_ERROR
558 * in the #G_IO_ERROR error domain is returned. Also, @dbus_error_name is
559 * added to the error message such that it can be recovered with
560 * g_dbus_error_get_remote_error().
562 * In all three cases, @dbus_error_name can always be recovered from the
563 * returned #GError using the g_dbus_error_get_remote_error() function
564 * (unless g_dbus_error_strip_remote_error() hasn't been used on the returned error).
566 * This function is typically only used in object mappings to prepare
567 * #GError instances for applications. Regular applications should not use
570 * Returns: An allocated #GError. Free with g_error_free().
573 g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
574 const gchar *dbus_error_message)
579 g_return_val_if_fail (dbus_error_name != NULL, NULL);
580 g_return_val_if_fail (dbus_error_message != NULL, NULL);
582 /* Ensure that e.g. G_DBUS_ERROR is registered using g_dbus_error_register_error() */
583 _g_dbus_initialize ();
588 if (dbus_error_name_to_re != NULL)
590 g_assert (quark_code_pair_to_re != NULL); /* check invariant */
591 re = g_hash_table_lookup (dbus_error_name_to_re, dbus_error_name);
596 error = g_error_new (re->pair.error_domain,
598 "GDBus.Error:%s: %s",
604 GQuark error_domain = 0;
607 if (_g_dbus_error_decode_gerror (dbus_error_name,
611 error = g_error_new (error_domain,
613 "GDBus.Error:%s: %s",
619 error = g_error_new (G_IO_ERROR,
620 G_IO_ERROR_DBUS_ERROR,
621 "GDBus.Error:%s: %s",
627 G_UNLOCK (error_lock);
632 * g_dbus_error_set_dbus_error:
633 * @error: A pointer to a #GError or %NULL.
634 * @dbus_error_name: D-Bus error name.
635 * @dbus_error_message: D-Bus error message.
636 * @format: printf()-style format to prepend to @dbus_error_message or %NULL.
637 * @...: Arguments for @format.
639 * Does nothing if @error is %NULL. Otherwise sets *@error to
640 * a new #GError created with g_dbus_error_new_for_dbus_error()
641 * with @dbus_error_message prepend with @format (unless %NULL).
644 g_dbus_error_set_dbus_error (GError **error,
645 const gchar *dbus_error_name,
646 const gchar *dbus_error_message,
650 g_return_if_fail (error == NULL || *error == NULL);
651 g_return_if_fail (dbus_error_name != NULL);
652 g_return_if_fail (dbus_error_message != NULL);
659 *error = g_dbus_error_new_for_dbus_error (dbus_error_name, dbus_error_message);
664 va_start (var_args, format);
665 g_dbus_error_set_dbus_error_valist (error,
675 * g_dbus_error_set_dbus_error_valist:
676 * @error: A pointer to a #GError or %NULL.
677 * @dbus_error_name: D-Bus error name.
678 * @dbus_error_message: D-Bus error message.
679 * @format: printf()-style format to prepend to @dbus_error_message or %NULL.
680 * @var_args: Arguments for @format.
682 * Like g_dbus_error_set_dbus_error() but intended for language bindings.
685 g_dbus_error_set_dbus_error_valist (GError **error,
686 const gchar *dbus_error_name,
687 const gchar *dbus_error_message,
691 g_return_if_fail (error == NULL || *error == NULL);
692 g_return_if_fail (dbus_error_name != NULL);
693 g_return_if_fail (dbus_error_message != NULL);
702 message = g_strdup_vprintf (format, var_args);
703 s = g_strdup_printf ("%s: %s", message, dbus_error_message);
704 *error = g_dbus_error_new_for_dbus_error (dbus_error_name, s);
710 *error = g_dbus_error_new_for_dbus_error (dbus_error_name, dbus_error_message);
715 * g_dbus_error_strip_remote_error:
718 * Looks for extra information in the error message used to recover
719 * the D-Bus error name and strips it if found. If stripped, the
720 * message field in @error will correspond exactly to what was
721 * received on the wire.
723 * This is typically used when presenting errors to the end user.
725 * Returns: %TRUE if information was stripped, %FALSE otherwise.
728 g_dbus_error_strip_remote_error (GError *error)
732 g_return_val_if_fail (error != NULL, FALSE);
736 if (g_str_has_prefix (error->message, "GDBus.Error:"))
742 begin = error->message + sizeof ("GDBus.Error:") -1;
743 end = strstr (begin, ":");
744 if (end != NULL && end[1] == ' ')
746 new_message = g_strdup (end + 2);
747 g_free (error->message);
748 error->message = new_message;
757 * g_dbus_error_encode_gerror:
760 * Creates a D-Bus error name to use for @error. If @error matches
761 * a registered error (cf. g_dbus_error_register_error()), the corresponding
762 * D-Bus error name will be returned.
764 * Otherwise the a name of the form
765 * <literal>org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE</literal>
766 * will be used. This allows other GDBus applications to map the error
767 * on the wire back to a #GError using g_dbus_error_new_for_dbus_error().
769 * This function is typically only used in object mappings to put a
770 * #GError on the wire. Regular applications should not use it.
772 * Returns: A D-Bus error name (never %NULL). Free with g_free().
775 g_dbus_error_encode_gerror (const GError *error)
780 g_return_val_if_fail (error != NULL, NULL);
782 /* Ensure that e.g. G_DBUS_ERROR is registered using g_dbus_error_register_error() */
783 _g_dbus_initialize ();
789 if (quark_code_pair_to_re != NULL)
792 pair.error_domain = error->domain;
793 pair.error_code = error->code;
794 g_assert (dbus_error_name_to_re != NULL); /* check invariant */
795 re = g_hash_table_lookup (quark_code_pair_to_re, &pair);
799 error_name = g_strdup (re->dbus_error_name);
800 G_UNLOCK (error_lock);
804 const gchar *domain_as_string;
808 G_UNLOCK (error_lock);
810 /* We can't make a lot of assumptions about what domain_as_string
811 * looks like and D-Bus is extremely picky about error names so
812 * hex-encode it for transport across the wire.
814 domain_as_string = g_quark_to_string (error->domain);
815 s = g_string_new ("org.gtk.GDBus.UnmappedGError.Quark._");
816 for (n = 0; domain_as_string[n] != 0; n++)
818 gint c = domain_as_string[n];
819 if (g_ascii_isalnum (c))
821 g_string_append_c (s, c);
827 g_string_append_c (s, '_');
828 nibble_top = ((int) domain_as_string[n]) >> 4;
829 nibble_bottom = ((int) domain_as_string[n]) & 0x0f;
833 nibble_top += 'a' - 10;
834 if (nibble_bottom < 10)
835 nibble_bottom += '0';
837 nibble_bottom += 'a' - 10;
838 g_string_append_c (s, nibble_top);
839 g_string_append_c (s, nibble_bottom);
842 g_string_append_printf (s, ".Code%d", error->code);
843 error_name = g_string_free (s, FALSE);