1 /* -*- mode: C; c-file-style: "gnu" -*- */
2 /* dbus-errors.c Error reporting
4 * Copyright (C) 2002 Red Hat Inc.
5 * Copyright (C) 2003 CodeFactory AB
7 * Licensed under the Academic Free License version 1.2
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
24 #include "dbus-errors.h"
25 #include "dbus-internals.h"
30 * @defgroup DBusErrors Error reporting
32 * @brief Error reporting
34 * Types and functions related to reporting errors.
37 * In essence D-BUS error reporting works as follows:
40 * DBusResultCode result = DBUS_RESULT_SUCCESS;
41 * dbus_some_function (arg1, arg2, &result);
42 * if (result != DBUS_RESULT_SUCCESS)
43 * printf ("an error occurred\n");
51 const char *name; /**< error name */
52 char *message; /**< error message */
54 unsigned int const_message : 1; /** Message is not owned by DBusError */
58 * Set a result code at a result code location,
59 * if code_address is not #NULL.
61 * @param code_address place to store the result code.
62 * @param code the result code itself.
65 dbus_set_result (DBusResultCode *code_address,
73 * Returns a string describing the given result code.
75 * @param code the result code to describe.
76 * @returns a constant string describing the code.
79 dbus_result_to_string (DBusResultCode code)
81 /* This is a switch to the compiler will complain if we
82 * aren't handling some codes
86 case DBUS_RESULT_SUCCESS:
88 case DBUS_RESULT_FAILED:
89 return "Unknown error";
90 case DBUS_RESULT_NO_MEMORY:
91 return "Not enough memory available";
92 case DBUS_RESULT_IO_ERROR:
93 return "Error reading or writing data";
94 case DBUS_RESULT_BAD_ADDRESS:
95 return "Could not parse address";
96 case DBUS_RESULT_NOT_SUPPORTED:
97 return "Feature not supported";
98 case DBUS_RESULT_LIMITS_EXCEEDED:
99 return "Resource limits exceeded";
100 case DBUS_RESULT_ACCESS_DENIED:
101 return "Permission denied";
102 case DBUS_RESULT_AUTH_FAILED:
103 return "Could not authenticate to server";
104 case DBUS_RESULT_NO_SERVER:
106 case DBUS_RESULT_TIMEOUT:
107 return "Connection timed out";
108 case DBUS_RESULT_NO_NETWORK:
109 return "Network unavailable";
110 case DBUS_RESULT_ADDRESS_IN_USE:
111 return "Address already in use";
112 case DBUS_RESULT_DISCONNECTED:
113 return "Disconnected.";
114 case DBUS_RESULT_INVALID_FIELDS:
115 return "Invalid fields.";
116 case DBUS_RESULT_NO_REPLY:
117 return "Did not get a reply message.";
118 case DBUS_RESULT_FILE_NOT_FOUND:
119 return "File doesn't exist.";
121 /* no default, it would break our compiler warnings */
124 return "Invalid error code";
128 * Initializes a DBusError structure.
130 * @param error the DBusError.
133 dbus_error_init (DBusError *error)
137 _dbus_assert (error != NULL);
139 _dbus_assert (sizeof (DBusError) == sizeof (DBusRealError));
141 real = (DBusRealError *)error;
144 real->message = NULL;
146 real->const_message = TRUE;
150 * Frees an error created by dbus_error_init().
152 * @param error memory where the error is stored.
155 dbus_error_free (DBusError *error)
159 real = (DBusRealError *)error;
161 if (!real->const_message)
162 dbus_free (real->message);
166 * Assigns an error name and message to a DBusError.
167 * Does nothing if error is #NULL.
169 * @param error the error.
170 * @param name the error name (not copied!!!)
171 * @param message the error message (not copied!!!)
174 dbus_set_error_const (DBusError *error,
183 dbus_error_init (error);
185 real = (DBusRealError *)error;
188 real->message = (char *)message;
189 real->const_message = TRUE;
193 * Assigns an error name and message to a DBusError.
194 * Does nothing if error is #NULL.
196 * @param error the error.
197 * @param name the error name (not copied!!!)
198 * @param format printf-style format string.
199 * @returns #TRUE on success.
202 dbus_set_error (DBusError *error,
216 va_start (args, format);
218 va_copy (args2, args);
220 /* Measure the message length */
221 message_length = vsnprintf (&c, 1,format, args) + 1;
223 message = dbus_malloc (message_length);
225 vsprintf (message, format, args2);
232 dbus_error_init (error);
233 real = (DBusRealError *)error;
236 real->message = message;
237 real->const_message = FALSE;