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>
28 #include "gdbuserror.h"
30 #include "gioenumtypes.h"
32 #include "gdbusprivate.h"
40 * @short_description: Mapping D-Bus errors to and from #GError
43 * All facilities that return errors from remote methods (such as
44 * g_dbus_connection_invoke_method_sync()) use #GError to represent
45 * both D-Bus errors (e.g. errors returned from the other peer) and
46 * locally in-process generated errors.
48 * To check if a returned #GError is an error from a remote peer, use
49 * g_dbus_error_is_remote_error(). To get the actual D-Bus error name,
50 * use g_dbus_error_get_remote_error(). Before presenting an error,
51 * always use g_dbus_error_strip_remote_error().
53 * In addition, facilities used to return errors to a remote peer also
54 * use #GError. See g_dbus_method_invocation_return_error() for
55 * discussion about how the D-Bus error name is set.
57 * Applications can associate a #GError error domain with a set of D-Bus errors in order to
58 * automatically map from D-Bus errors to #GError and back. This
59 * is typically done in the function returning the #GQuark for the
61 * <example id="error-registration"><title>Error Registration</title><programlisting>
62 * /<!-- -->* foo-bar-error.h: *<!-- -->/
64 * #define FOO_BAR_ERROR (foo_bar_error_quark ())
65 * GQuark foo_bar_error_quark (void);
69 * FOO_BAR_ERROR_FAILED,
70 * FOO_BAR_ERROR_ANOTHER_ERROR,
71 * FOO_BAR_ERROR_SOME_THIRD_ERROR,
74 * /<!-- -->* foo-bar-error.c: *<!-- -->/
76 * static const GDBusErrorEntry foo_bar_error_entries[] =
78 * {FOO_BAR_ERROR_FAILED, "org.project.Foo.Bar.Error.Failed"},
79 * {FOO_BAR_ERROR_ANOTHER_ERROR, "org.project.Foo.Bar.Error.AnotherError"},
80 * {FOO_BAR_ERROR_SOME_THIRD_ERROR, "org.project.Foo.Bar.Error.SomeThirdError"},
84 * foo_bar_error_quark (void)
86 * static volatile gsize quark_volatile = 0;
87 * g_dbus_error_register_error_domain ("foo-bar-error-quark",
89 * foo_bar_error_entries,
90 * G_N_ELEMENTS (foo_bar_error_entries));
91 * G_STATIC_ASSERT (G_N_ELEMENTS (foo_bar_error_entries) - 1 == FOO_BAR_ERROR_SOME_THIRD_ERROR);
92 * return (GQuark) quark_volatile;
94 * </programlisting></example>
95 * With this setup, a D-Bus peer can transparently pass e.g. %FOO_BAR_ERROR_ANOTHER_ERROR and
96 * other peers will see the D-Bus error name <literal>org.project.Foo.Bar.Error.AnotherError</literal>.
97 * If the other peer is using GDBus, the peer will see also %FOO_BAR_ERROR_ANOTHER_ERROR instead
98 * of %G_IO_ERROR_DBUS_ERROR. Note that GDBus clients can still recover
99 * <literal>org.project.Foo.Bar.Error.AnotherError</literal> using g_dbus_error_get_remote_error().
101 * Note that errors in the %G_DBUS_ERROR error domain is intended only
102 * for returning errors from a remote message bus process. Errors
103 * generated locally in-process by e.g. #GDBusConnection is from the
104 * %G_IO_ERROR domain.
107 static const GDBusErrorEntry g_dbus_error_entries[] =
109 {G_DBUS_ERROR_FAILED, "org.freedesktop.DBus.Error.Failed"},
110 {G_DBUS_ERROR_NO_MEMORY, "org.freedesktop.DBus.Error.NoMemory"},
111 {G_DBUS_ERROR_SERVICE_UNKNOWN, "org.freedesktop.DBus.Error.ServiceUnknown"},
112 {G_DBUS_ERROR_NAME_HAS_NO_OWNER, "org.freedesktop.DBus.Error.NameHasNoOwner"},
113 {G_DBUS_ERROR_NO_REPLY, "org.freedesktop.DBus.Error.NoReply"},
114 {G_DBUS_ERROR_IO_ERROR, "org.freedesktop.DBus.Error.IOError"},
115 {G_DBUS_ERROR_BAD_ADDRESS, "org.freedesktop.DBus.Error.BadAddress"},
116 {G_DBUS_ERROR_NOT_SUPPORTED, "org.freedesktop.DBus.Error.NotSupported"},
117 {G_DBUS_ERROR_LIMITS_EXCEEDED, "org.freedesktop.DBus.Error.LimitsExceeded"},
118 {G_DBUS_ERROR_ACCESS_DENIED, "org.freedesktop.DBus.Error.AccessDenied"},
119 {G_DBUS_ERROR_AUTH_FAILED, "org.freedesktop.DBus.Error.AuthFailed"},
120 {G_DBUS_ERROR_NO_SERVER, "org.freedesktop.DBus.Error.NoServer"},
121 {G_DBUS_ERROR_TIMEOUT, "org.freedesktop.DBus.Error.Timeout"},
122 {G_DBUS_ERROR_NO_NETWORK, "org.freedesktop.DBus.Error.NoNetwork"},
123 {G_DBUS_ERROR_ADDRESS_IN_USE, "org.freedesktop.DBus.Error.AddressInUse"},
124 {G_DBUS_ERROR_DISCONNECTED, "org.freedesktop.DBus.Error.Disconnected"},
125 {G_DBUS_ERROR_INVALID_ARGS, "org.freedesktop.DBus.Error.InvalidArgs"},
126 {G_DBUS_ERROR_FILE_NOT_FOUND, "org.freedesktop.DBus.Error.FileNotFound"},
127 {G_DBUS_ERROR_FILE_EXISTS, "org.freedesktop.DBus.Error.FileExists"},
128 {G_DBUS_ERROR_UNKNOWN_METHOD, "org.freedesktop.DBus.Error.UnknownMethod"},
129 {G_DBUS_ERROR_TIMED_OUT, "org.freedesktop.DBus.Error.TimedOut"},
130 {G_DBUS_ERROR_MATCH_RULE_NOT_FOUND, "org.freedesktop.DBus.Error.MatchRuleNotFound"},
131 {G_DBUS_ERROR_MATCH_RULE_INVALID, "org.freedesktop.DBus.Error.MatchRuleInvalid"},
132 {G_DBUS_ERROR_SPAWN_EXEC_FAILED, "org.freedesktop.DBus.Error.Spawn.ExecFailed"},
133 {G_DBUS_ERROR_SPAWN_FORK_FAILED, "org.freedesktop.DBus.Error.Spawn.ForkFailed"},
134 {G_DBUS_ERROR_SPAWN_CHILD_EXITED, "org.freedesktop.DBus.Error.Spawn.ChildExited"},
135 {G_DBUS_ERROR_SPAWN_CHILD_SIGNALED, "org.freedesktop.DBus.Error.Spawn.ChildSignaled"},
136 {G_DBUS_ERROR_SPAWN_FAILED, "org.freedesktop.DBus.Error.Spawn.Failed"},
137 {G_DBUS_ERROR_SPAWN_SETUP_FAILED, "org.freedesktop.DBus.Error.Spawn.FailedToSetup"},
138 {G_DBUS_ERROR_SPAWN_CONFIG_INVALID, "org.freedesktop.DBus.Error.Spawn.ConfigInvalid"},
139 {G_DBUS_ERROR_SPAWN_SERVICE_INVALID, "org.freedesktop.DBus.Error.Spawn.ServiceNotValid"},
140 {G_DBUS_ERROR_SPAWN_SERVICE_NOT_FOUND, "org.freedesktop.DBus.Error.Spawn.ServiceNotFound"},
141 {G_DBUS_ERROR_SPAWN_PERMISSIONS_INVALID, "org.freedesktop.DBus.Error.Spawn.PermissionsInvalid"},
142 {G_DBUS_ERROR_SPAWN_FILE_INVALID, "org.freedesktop.DBus.Error.Spawn.FileInvalid"},
143 {G_DBUS_ERROR_SPAWN_NO_MEMORY, "org.freedesktop.DBus.Error.Spawn.NoMemory"},
144 {G_DBUS_ERROR_UNIX_PROCESS_ID_UNKNOWN, "org.freedesktop.DBus.Error.UnixProcessIdUnknown"},
145 {G_DBUS_ERROR_INVALID_SIGNATURE, "org.freedesktop.DBus.Error.InvalidSignature"},
146 {G_DBUS_ERROR_INVALID_FILE_CONTENT, "org.freedesktop.DBus.Error.InvalidFileContent"},
147 {G_DBUS_ERROR_SELINUX_SECURITY_CONTEXT_UNKNOWN, "org.freedesktop.DBus.Error.SELinuxSecurityContextUnknown"},
148 {G_DBUS_ERROR_ADT_AUDIT_DATA_UNKNOWN, "org.freedesktop.DBus.Error.AdtAuditDataUnknown"},
149 {G_DBUS_ERROR_OBJECT_PATH_IN_USE, "org.freedesktop.DBus.Error.ObjectPathInUse"},
153 g_dbus_error_quark (void)
155 static volatile gsize quark_volatile = 0;
156 g_dbus_error_register_error_domain ("g-dbus-error-quark",
158 g_dbus_error_entries,
159 G_N_ELEMENTS (g_dbus_error_entries));
160 G_STATIC_ASSERT (G_N_ELEMENTS (g_dbus_error_entries) - 1 == G_DBUS_ERROR_OBJECT_PATH_IN_USE);
161 return (GQuark) quark_volatile;
165 * g_dbus_error_register_error_domain:
166 * @error_domain_quark_name: The error domain name.
167 * @quark_volatile: A pointer where to store the #GQuark.
168 * @entries: A pointer to @num_entries #GDBusErrorEntry struct items.
169 * @num_entries: Number of items to register.
171 * Helper function for associating a #GError error domain with D-Bus error names.
176 g_dbus_error_register_error_domain (const gchar *error_domain_quark_name,
177 volatile gsize *quark_volatile,
178 const GDBusErrorEntry *entries,
181 g_return_if_fail (error_domain_quark_name != NULL);
182 g_return_if_fail (quark_volatile != NULL);
183 g_return_if_fail (entries != NULL);
184 g_return_if_fail (num_entries > 0);
186 if (g_once_init_enter (quark_volatile))
191 quark = g_quark_from_static_string (error_domain_quark_name);
193 for (n = 0; n < num_entries; n++)
195 g_warn_if_fail (g_dbus_error_register_error (quark,
196 entries[n].error_code,
197 entries[n].dbus_error_name));
199 g_once_init_leave (quark_volatile, quark);
204 _g_dbus_error_decode_gerror (const gchar *dbus_name,
205 GQuark *out_error_domain,
206 gint *out_error_code)
211 gchar *domain_quark_string;
216 if (g_str_has_prefix (dbus_name, "org.gtk.GDBus.UnmappedGError.Quark._"))
218 s = g_string_new (NULL);
220 for (n = sizeof "org.gtk.GDBus.UnmappedGError.Quark._" - 1;
221 dbus_name[n] != '.' && dbus_name[n] != '\0';
224 if (g_ascii_isalnum (dbus_name[n]))
226 g_string_append_c (s, dbus_name[n]);
228 else if (dbus_name[n] == '_')
235 nibble_top = dbus_name[n];
236 if (nibble_top >= '0' && nibble_top <= '9')
238 else if (nibble_top >= 'a' && nibble_top <= 'f')
239 nibble_top -= ('a' - 10);
245 nibble_bottom = dbus_name[n];
246 if (nibble_bottom >= '0' && nibble_bottom <= '9')
247 nibble_bottom -= '0';
248 else if (nibble_bottom >= 'a' && nibble_bottom <= 'f')
249 nibble_bottom -= ('a' - 10);
253 g_string_append_c (s, (nibble_top<<4) | nibble_bottom);
261 if (!g_str_has_prefix (dbus_name + n, ".Code"))
264 domain_quark_string = g_string_free (s, FALSE);
267 if (out_error_domain != NULL)
268 *out_error_domain = g_quark_from_string (domain_quark_string);
269 g_free (domain_quark_string);
271 if (out_error_code != NULL)
272 *out_error_code = atoi (dbus_name + n + sizeof ".Code" - 1);
280 g_string_free (s, TRUE);
285 /* ---------------------------------------------------------------------------------------------------- */
294 quark_code_pair_hash_func (const QuarkCodePair *pair)
297 val = pair->error_domain + pair->error_code;
298 return g_int_hash (&val);
302 quark_code_pair_equal_func (const QuarkCodePair *a,
303 const QuarkCodePair *b)
305 return (a->error_domain == b->error_domain) && (a->error_code == b->error_code);
311 gchar *dbus_error_name;
315 registered_error_free (RegisteredError *re)
317 g_free (re->dbus_error_name);
321 G_LOCK_DEFINE_STATIC (error_lock);
323 /* maps from QuarkCodePair* -> RegisteredError* */
324 static GHashTable *quark_code_pair_to_re = NULL;
326 /* maps from gchar* -> RegisteredError* */
327 static GHashTable *dbus_error_name_to_re = NULL;
330 * g_dbus_error_register_error:
331 * @error_domain: A #GQuark for a error domain.
332 * @error_code: An error code.
333 * @dbus_error_name: A D-Bus error name.
335 * Creates an association to map between @dbus_error_name and
336 * #GError<!-- -->s specified by @error_domain and @error_code.
338 * This is typically done in the routine that returns the #GQuark for
341 * Returns: %TRUE if the association was created, %FALSE if it already
347 g_dbus_error_register_error (GQuark error_domain,
349 const gchar *dbus_error_name)
355 g_return_val_if_fail (dbus_error_name != NULL, FALSE);
361 if (quark_code_pair_to_re == NULL)
363 g_assert (dbus_error_name_to_re == NULL); /* check invariant */
364 quark_code_pair_to_re = g_hash_table_new ((GHashFunc) quark_code_pair_hash_func,
365 (GEqualFunc) quark_code_pair_equal_func);
366 dbus_error_name_to_re = g_hash_table_new_full (g_str_hash,
369 (GDestroyNotify) registered_error_free);
372 if (g_hash_table_lookup (dbus_error_name_to_re, dbus_error_name) != NULL)
375 pair.error_domain = error_domain;
376 pair.error_code = error_code;
378 if (g_hash_table_lookup (quark_code_pair_to_re, &pair) != NULL)
381 re = g_new0 (RegisteredError, 1);
383 re->dbus_error_name = g_strdup (dbus_error_name);
385 g_hash_table_insert (quark_code_pair_to_re, &(re->pair), re);
386 g_hash_table_insert (dbus_error_name_to_re, re->dbus_error_name, re);
391 G_UNLOCK (error_lock);
396 * g_dbus_error_unregister_error:
397 * @error_domain: A #GQuark for a error domain.
398 * @error_code: An error code.
399 * @dbus_error_name: A D-Bus error name.
401 * Destroys an association previously set up with g_dbus_error_register_error().
403 * Returns: %TRUE if the association was destroyed, %FALSE if it wasn't found.
408 g_dbus_error_unregister_error (GQuark error_domain,
410 const gchar *dbus_error_name)
416 g_return_val_if_fail (dbus_error_name != NULL, FALSE);
422 if (dbus_error_name_to_re == NULL)
424 g_assert (quark_code_pair_to_re == NULL); /* check invariant */
428 re = g_hash_table_lookup (dbus_error_name_to_re, dbus_error_name);
432 pair.error_domain = error_domain;
433 pair.error_code = error_code;
434 g_warn_if_fail (g_hash_table_lookup (quark_code_pair_to_re, &pair) == NULL); /* check invariant */
437 g_warn_if_fail (g_hash_table_lookup (quark_code_pair_to_re, &(re->pair)) == re); /* check invariant */
439 g_warn_if_fail (g_hash_table_remove (quark_code_pair_to_re, &(re->pair)));
440 g_warn_if_fail (g_hash_table_remove (dbus_error_name_to_re, re));
442 /* destroy hashes if empty */
443 hash_size = g_hash_table_size (dbus_error_name_to_re);
446 g_warn_if_fail (g_hash_table_size (quark_code_pair_to_re) == 0); /* check invariant */
448 g_hash_table_unref (dbus_error_name_to_re);
449 dbus_error_name_to_re = NULL;
450 g_hash_table_unref (quark_code_pair_to_re);
451 quark_code_pair_to_re = NULL;
455 g_warn_if_fail (g_hash_table_size (quark_code_pair_to_re) == hash_size); /* check invariant */
459 G_UNLOCK (error_lock);
463 /* ---------------------------------------------------------------------------------------------------- */
466 * g_dbus_error_is_remote_error:
469 * Checks if @error represents an error received via D-Bus from a remote peer. If so,
470 * use g_dbus_error_get_remote_error() to get the name of the error.
472 * Returns: %TRUE if @error represents an error from a remote peer,
478 g_dbus_error_is_remote_error (const GError *error)
480 g_return_val_if_fail (error != NULL, FALSE);
481 return g_str_has_prefix (error->message, "GDBus.Error:");
486 * g_dbus_error_get_remote_error:
489 * Gets the D-Bus error name used for @error, if any.
491 * This function is guaranteed to return a D-Bus error name for all #GError<!-- -->s returned from
492 * functions handling remote method calls (e.g. g_dbus_connection_invoke_method_finish())
493 * unless g_dbus_error_strip_remote_error() has been used on @error.
495 * Returns: An allocated string or %NULL if the D-Bus error name could not be found. Free with g_free().
500 g_dbus_error_get_remote_error (const GError *error)
505 g_return_val_if_fail (error != NULL, NULL);
507 /* Ensure that e.g. G_DBUS_ERROR is registered using g_dbus_error_register_error() */
508 _g_dbus_initialize ();
515 if (quark_code_pair_to_re != NULL)
518 pair.error_domain = error->domain;
519 pair.error_code = error->code;
520 g_assert (dbus_error_name_to_re != NULL); /* check invariant */
521 re = g_hash_table_lookup (quark_code_pair_to_re, &pair);
526 ret = g_strdup (re->dbus_error_name);
530 if (g_str_has_prefix (error->message, "GDBus.Error:"))
534 begin = error->message + sizeof ("GDBus.Error:") -1;
535 end = strstr (begin, ":");
536 if (end != NULL && end[1] == ' ')
538 ret = g_strndup (begin, end - begin);
543 G_UNLOCK (error_lock);
548 /* ---------------------------------------------------------------------------------------------------- */
551 * g_dbus_error_new_for_dbus_error:
552 * @dbus_error_name: D-Bus error name.
553 * @dbus_error_message: D-Bus error message.
555 * Creates a #GError based on the contents of @dbus_error_name and
556 * @dbus_error_message.
558 * Errors registered with g_dbus_error_register_error() will be looked
559 * up using @dbus_error_name and if a match is found, the error domain
560 * and code is used. Applications can use g_dbus_error_get_remote_error()
561 * to recover @dbus_error_name.
563 * If a match against a registered error is not found and the D-Bus
564 * error name is in a form as returned by g_dbus_error_encode_gerror()
565 * the error domain and code encoded in the name is used to
566 * create the #GError. Also, @dbus_error_name is added to the error message
567 * such that it can be recovered with g_dbus_error_get_remote_error().
569 * Otherwise, a #GError with the error code %G_IO_ERROR_DBUS_ERROR
570 * in the #G_IO_ERROR error domain is returned. Also, @dbus_error_name is
571 * added to the error message such that it can be recovered with
572 * g_dbus_error_get_remote_error().
574 * In all three cases, @dbus_error_name can always be recovered from the
575 * returned #GError using the g_dbus_error_get_remote_error() function
576 * (unless g_dbus_error_strip_remote_error() hasn't been used on the returned error).
578 * This function is typically only used in object mappings to prepare
579 * #GError instances for applications. Regular applications should not use
582 * Returns: An allocated #GError. Free with g_error_free().
587 g_dbus_error_new_for_dbus_error (const gchar *dbus_error_name,
588 const gchar *dbus_error_message)
593 g_return_val_if_fail (dbus_error_name != NULL, NULL);
594 g_return_val_if_fail (dbus_error_message != NULL, NULL);
596 /* Ensure that e.g. G_DBUS_ERROR is registered using g_dbus_error_register_error() */
597 _g_dbus_initialize ();
602 if (dbus_error_name_to_re != NULL)
604 g_assert (quark_code_pair_to_re != NULL); /* check invariant */
605 re = g_hash_table_lookup (dbus_error_name_to_re, dbus_error_name);
610 error = g_error_new (re->pair.error_domain,
612 "GDBus.Error:%s: %s",
618 GQuark error_domain = 0;
621 if (_g_dbus_error_decode_gerror (dbus_error_name,
625 error = g_error_new (error_domain,
627 "GDBus.Error:%s: %s",
633 error = g_error_new (G_IO_ERROR,
634 G_IO_ERROR_DBUS_ERROR,
635 "GDBus.Error:%s: %s",
641 G_UNLOCK (error_lock);
646 * g_dbus_error_set_dbus_error:
647 * @error: A pointer to a #GError or %NULL.
648 * @dbus_error_name: D-Bus error name.
649 * @dbus_error_message: D-Bus error message.
650 * @format: printf()-style format to prepend to @dbus_error_message or %NULL.
651 * @...: Arguments for @format.
653 * Does nothing if @error is %NULL. Otherwise sets *@error to
654 * a new #GError created with g_dbus_error_new_for_dbus_error()
655 * with @dbus_error_message prepend with @format (unless %NULL).
660 g_dbus_error_set_dbus_error (GError **error,
661 const gchar *dbus_error_name,
662 const gchar *dbus_error_message,
666 g_return_if_fail (error == NULL || *error == NULL);
667 g_return_if_fail (dbus_error_name != NULL);
668 g_return_if_fail (dbus_error_message != NULL);
675 *error = g_dbus_error_new_for_dbus_error (dbus_error_name, dbus_error_message);
680 va_start (var_args, format);
681 g_dbus_error_set_dbus_error_valist (error,
691 * g_dbus_error_set_dbus_error_valist:
692 * @error: A pointer to a #GError or %NULL.
693 * @dbus_error_name: D-Bus error name.
694 * @dbus_error_message: D-Bus error message.
695 * @format: printf()-style format to prepend to @dbus_error_message or %NULL.
696 * @var_args: Arguments for @format.
698 * Like g_dbus_error_set_dbus_error() but intended for language bindings.
703 g_dbus_error_set_dbus_error_valist (GError **error,
704 const gchar *dbus_error_name,
705 const gchar *dbus_error_message,
709 g_return_if_fail (error == NULL || *error == NULL);
710 g_return_if_fail (dbus_error_name != NULL);
711 g_return_if_fail (dbus_error_message != NULL);
720 message = g_strdup_vprintf (format, var_args);
721 s = g_strdup_printf ("%s: %s", message, dbus_error_message);
722 *error = g_dbus_error_new_for_dbus_error (dbus_error_name, s);
728 *error = g_dbus_error_new_for_dbus_error (dbus_error_name, dbus_error_message);
733 * g_dbus_error_strip_remote_error:
736 * Looks for extra information in the error message used to recover
737 * the D-Bus error name and strips it if found. If stripped, the
738 * message field in @error will correspond exactly to what was
739 * received on the wire.
741 * This is typically used when presenting errors to the end user.
743 * Returns: %TRUE if information was stripped, %FALSE otherwise.
748 g_dbus_error_strip_remote_error (GError *error)
752 g_return_val_if_fail (error != NULL, FALSE);
756 if (g_str_has_prefix (error->message, "GDBus.Error:"))
762 begin = error->message + sizeof ("GDBus.Error:") -1;
763 end = strstr (begin, ":");
764 if (end != NULL && end[1] == ' ')
766 new_message = g_strdup (end + 2);
767 g_free (error->message);
768 error->message = new_message;
777 * g_dbus_error_encode_gerror:
780 * Creates a D-Bus error name to use for @error. If @error matches
781 * a registered error (cf. g_dbus_error_register_error()), the corresponding
782 * D-Bus error name will be returned.
784 * Otherwise the a name of the form
785 * <literal>org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE</literal>
786 * will be used. This allows other GDBus applications to map the error
787 * on the wire back to a #GError using g_dbus_error_new_for_dbus_error().
789 * This function is typically only used in object mappings to put a
790 * #GError on the wire. Regular applications should not use it.
792 * Returns: A D-Bus error name (never %NULL). Free with g_free().
797 g_dbus_error_encode_gerror (const GError *error)
802 g_return_val_if_fail (error != NULL, NULL);
804 /* Ensure that e.g. G_DBUS_ERROR is registered using g_dbus_error_register_error() */
805 _g_dbus_initialize ();
811 if (quark_code_pair_to_re != NULL)
814 pair.error_domain = error->domain;
815 pair.error_code = error->code;
816 g_assert (dbus_error_name_to_re != NULL); /* check invariant */
817 re = g_hash_table_lookup (quark_code_pair_to_re, &pair);
821 error_name = g_strdup (re->dbus_error_name);
822 G_UNLOCK (error_lock);
826 const gchar *domain_as_string;
830 G_UNLOCK (error_lock);
832 /* We can't make a lot of assumptions about what domain_as_string
833 * looks like and D-Bus is extremely picky about error names so
834 * hex-encode it for transport across the wire.
836 domain_as_string = g_quark_to_string (error->domain);
837 s = g_string_new ("org.gtk.GDBus.UnmappedGError.Quark._");
838 for (n = 0; domain_as_string[n] != 0; n++)
840 gint c = domain_as_string[n];
841 if (g_ascii_isalnum (c))
843 g_string_append_c (s, c);
849 g_string_append_c (s, '_');
850 nibble_top = ((int) domain_as_string[n]) >> 4;
851 nibble_bottom = ((int) domain_as_string[n]) & 0x0f;
855 nibble_top += 'a' - 10;
856 if (nibble_bottom < 10)
857 nibble_bottom += '0';
859 nibble_bottom += 'a' - 10;
860 g_string_append_c (s, nibble_top);
861 g_string_append_c (s, nibble_bottom);
864 g_string_append_printf (s, ".Code%d", error->code);
865 error_name = g_string_free (s, FALSE);
871 #define __G_DBUS_ERROR_C__
872 #include "gioaliasdef.c"