Allocate GErrors using the slice allocator. (#354054, Matt Barnes)

[platform/upstream/glib.git] / glib / gerror.c

diff --git a/glib/gerror.c b/glib/gerror.c
index 17baf19..0b0f982 100644 (file)
--- a/glib/gerror.c
+++ b/glib/gerror.c
@@ -24,17 +24,21 @@
  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
  */
 
+#include "config.h"
+
 #include "glib.h"
+#include "galias.h"
+
 
 static GError* 
-g_error_new_valist(GQuark         domain,
-                   gint           code,
-                   const gchar   *format,
-                   va_list        args)
+g_error_new_valist (GQuark         domain,
+                    gint           code,
+                    const gchar   *format,
+                    va_list        args)
 {
   GError *error;
   
-  error = g_new (GError, 1);
+  error = g_slice_new (GError);
   
   error->domain = domain;
   error->code = code;
@@ -43,6 +47,18 @@ g_error_new_valist(GQuark         domain,
   return error;
 }
 
+/**
+ * g_error_new:
+ * @domain: error domain 
+ * @code: error code
+ * @format: printf()-style format for error message
+ * @Varargs: parameters for message format
+ * 
+ * Creates a new #GError with the given @domain and @code,
+ * and a message formatted with @format.
+ * 
+ * Return value: a new #GError
+ **/
 GError*
 g_error_new (GQuark       domain,
              gint         code,
@@ -62,6 +78,19 @@ g_error_new (GQuark       domain,
   return error;
 }
 
+/**
+ * g_error_new_literal:
+ * @domain: error domain
+ * @code: error code
+ * @message: error message
+ * 
+ * Creates a new #GError; unlike g_error_new(), @message is not
+ * a printf()-style format string. Use this 
+ * function if @message contains text you don't have control over, 
+ * that could include printf() escape sequences.
+ * 
+ * Return value: a new #GError
+ **/
 GError*
 g_error_new_literal (GQuark         domain,
                      gint           code,
@@ -72,7 +101,7 @@ g_error_new_literal (GQuark         domain,
   g_return_val_if_fail (message != NULL, NULL);
   g_return_val_if_fail (domain != 0, NULL);
 
-  err = g_new (GError, 1);
+  err = g_slice_new (GError);
 
   err->domain = domain;
   err->code = code;
@@ -81,6 +110,13 @@ g_error_new_literal (GQuark         domain,
   return err;
 }
 
+/**
+ * g_error_free:
+ * @error: a #GError
+ *
+ * Frees a #GError and associated resources.
+ * 
+ **/
 void
 g_error_free (GError *error)
 {
@@ -88,9 +124,17 @@ g_error_free (GError *error)
 
   g_free (error->message);
 
-  g_free (error);
+  g_slice_free (GError, error);
 }
 
+/**
+ * g_error_copy:
+ * @error: a #GError
+ * 
+ * Makes a copy of @error.
+ * 
+ * Return value: a new #GError
+ **/
 GError*
 g_error_copy (const GError *error)
 {
@@ -98,7 +142,7 @@ g_error_copy (const GError *error)
   
   g_return_val_if_fail (error != NULL, NULL);
 
-  copy = g_new (GError, 1);
+  copy = g_slice_new (GError);
 
   *copy = *error;
 
@@ -107,6 +151,17 @@ g_error_copy (const GError *error)
   return copy;
 }
 
+/**
+ * g_error_matches:
+ * @error: a #GError
+ * @domain: an error domain
+ * @code: an error code
+ * 
+ * Returns %TRUE if @error matches @domain and @code, %FALSE
+ * otherwise.
+ * 
+ * Return value: whether @error has @domain and @code
+ **/
 gboolean
 g_error_matches (const GError *error,
                  GQuark        domain,
@@ -118,8 +173,20 @@ g_error_matches (const GError *error,
 }
 
 #define ERROR_OVERWRITTEN_WARNING "GError set over the top of a previous GError or uninitialized memory.\n" \
-               "This indicates a bug in someone's code. You must ensure an error is NULL before it's set."
+               "This indicates a bug in someone's code. You must ensure an error is NULL before it's set.\n" \
+               "The overwriting error message was: %s"
 
+/**
+ * g_set_error:
+ * @err: a return location for a #GError, or %NULL
+ * @domain: error domain
+ * @code: error code 
+ * @format: printf()-style format
+ * @Varargs: args for @format 
+ * 
+ * Does nothing if @err is %NULL; if @err is non-%NULL, then *@err must
+ * be %NULL. A new #GError is created and assigned to *@err.
+ **/
 void
 g_set_error (GError      **err,
              GQuark        domain,
@@ -127,34 +194,59 @@ g_set_error (GError      **err,
              const gchar  *format,
              ...)
 {
+  GError *new;
+  
   va_list args;
 
   if (err == NULL)
     return;
-
-  if (*err != NULL)
-    g_warning (ERROR_OVERWRITTEN_WARNING);
   
   va_start (args, format);
-  *err = g_error_new_valist (domain, code, format, args);
+  new = g_error_new_valist (domain, code, format, args);
   va_end (args);
+
+  if (*err == NULL)
+    *err = new;
+  else
+    g_warning (ERROR_OVERWRITTEN_WARNING, new->message);    
 }
 
+/**
+ * g_propagate_error:
+ * @dest: error return location
+ * @src: error to move into the return location
+ * 
+ * If @dest is %NULL, free @src; otherwise,
+ * moves @src into *@dest. *@dest must be %NULL.
+ **/
 void    
 g_propagate_error (GError       **dest,
                   GError        *src)
 {
   g_return_if_fail (src != NULL);
-
-  if (dest == NULL)
-    return;
   
-  if (*dest != NULL)
-    g_warning (ERROR_OVERWRITTEN_WARNING);
- 
-  *dest = src;
+  if (dest == NULL)
+    {
+      if (src)
+        g_error_free (src);
+      return;
+    }
+  else
+    {
+      if (*dest != NULL)
+        g_warning (ERROR_OVERWRITTEN_WARNING, src->message);
+      else
+        *dest = src;
+    }
 }
 
+/**
+ * g_clear_error:
+ * @err: a #GError return location
+ * 
+ * If @err is %NULL, does nothing. If @err is non-%NULL,
+ * calls g_error_free() on *@err and sets *@err to %NULL.
+ **/
 void
 g_clear_error (GError **err)
 {
@@ -164,3 +256,6 @@ g_clear_error (GError **err)
       *err = NULL;
     }
 }
+
+#define __G_ERROR_C__
+#include "galiasdef.c"