Free the src error if the dest location is NULL - I'm pretty sure that's
[platform/upstream/glib.git] / gerror.c
index cff505b..c365bd2 100644 (file)
--- a/gerror.c
+++ b/gerror.c
  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
  *
  * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
  *
  * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
  * License along with this library; if not, write to the
  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  * Boston, MA 02111-1307, USA.
  */
-#include <signal.h>
-#include <stdarg.h>
-#include <stdio.h>
-#include <stdlib.h>
-#include <sys/time.h>
-#include <sys/times.h>
-#include <sys/types.h>
 
-#include <time.h>
-#include <unistd.h>
-#include "glib.h"
-
-#ifdef HAVE_SYS_SELECT_H
-#include <sys/select.h>
-#endif /* HAVE_SYS_SELECT_H */
-
-#ifdef STDC_HEADERS
-#include <string.h> /* for bzero on BSD systems */
-#endif
-
-#define INTERACTIVE 0
-#define STACK_TRACE 1
+/*
+ * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
+ * file for a list of people on the GLib Team.  See the ChangeLog
+ * files for a list of changes.  These files are distributed with
+ * GLib at ftp://ftp.gtk.org/pub/gtk/. 
+ */
 
+#include "glib.h"
 
-#ifndef NO_FD_SET
-#  define SELECT_MASK fd_set
-#else
-#  ifndef _AIX
-     typedef long fd_mask;
-#  endif
-#  if defined(_IBMR2)
-#    define SELECT_MASK void
-#  else
-#    define SELECT_MASK int
-#  endif
-#endif
+static GError* 
+g_error_new_valist(GQuark         domain,
+                   gint           code,
+                   const gchar   *format,
+                   va_list        args)
+{
+  GError *error;
+  
+  error = g_new (GError, 1);
+  
+  error->domain = domain;
+  error->code = code;
+  error->message = g_strdup_vprintf (format, args);
+  
+  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,
+             const gchar *format,
+             ...)
+{
+  GError* error;
+  va_list args;
 
-static int  do_query (char *prompt);
-static void debug (const gchar *progname, int method);
-static void stack_trace (char **);
-static void stack_trace_sigchld (int);
+  g_return_val_if_fail (format != NULL, NULL);
+  g_return_val_if_fail (domain != 0, NULL);
 
+  va_start (args, format);
+  error = g_error_new_valist (domain, code, format, args);
+  va_end (args);
 
-static int stack_trace_done;
+  return error;
+}
 
-void
-g_debug (const gchar *progname)
+/**
+ * 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,
+                     const gchar   *message)
 {
-  char buf[32];
+  GError* err;
 
-  fprintf (stdout, "[n]othing, [e]xit, [s]tack trace, [a]ttach to process: ");
-  fflush (stdout);
+  g_return_val_if_fail (message != NULL, NULL);
+  g_return_val_if_fail (domain != 0, NULL);
 
-  fgets (buf, 32, stdin);
-  if (strcmp (buf, "n\n") == 0)
-    return;
-  else if (strcmp (buf, "s\n") == 0)
-    debug (progname, STACK_TRACE);
-  else if (strcmp (buf, "a\n") == 0)
-    debug (progname, INTERACTIVE);
-  else
-    exit (0);
-}
+  err = g_new (GError, 1);
 
-void
-g_attach_process (const gchar *progname,
-                 gboolean     query)
-{
-  if (!query || do_query ("attach to process"))
-    debug (progname, INTERACTIVE);
+  err->domain = domain;
+  err->code = code;
+  err->message = g_strdup (message);
+  
+  return err;
 }
 
+/**
+ * g_error_free:
+ * @error: a #GError
+ *
+ * Frees a #GError and associated resources.
+ * 
+ **/
 void
-g_stack_trace (const gchar *progname,
-              gboolean     query)
+g_error_free (GError *error)
 {
-  if (!query || do_query ("print stack trace"))
-    debug (progname, STACK_TRACE);
-}
-
-static int
-do_query (char *prompt)
-{
-  char buf[32];
+  g_return_if_fail (error != NULL);  
 
-  fprintf (stdout, "%s (y/n) ", prompt);
-  fflush (stdout);
+  g_free (error->message);
 
-  fgets (buf, 32, stdin);
-  if ((strcmp (buf, "yes\n") == 0) ||
-      (strcmp (buf, "y\n") == 0) ||
-      (strcmp (buf, "YES\n") == 0) ||
-      (strcmp (buf, "Y\n") == 0))
-    return TRUE;
-
-  return FALSE;
+  g_free (error);
 }
 
-static void
-debug (const char *progname,
-       int   method)
+/**
+ * g_error_copy:
+ * @error: a #GError
+ * 
+ * Makes a copy of @error.
+ * 
+ * Return value: a new #GError
+ **/
+GError*
+g_error_copy (const GError *error)
 {
-  pid_t pid;
-  char buf[16];
-  char *args[4] = { "gdb", NULL, NULL, NULL };
-  volatile int x;
+  GError *copy;
+  
+  g_return_val_if_fail (error != NULL, NULL);
 
-  sprintf (buf, "%d", (int) getpid ());
+  copy = g_new (GError, 1);
 
-  args[1] = (gchar*) progname;
-  args[2] = buf;
+  *copy = *error;
 
-  switch (method)
-    {
-    case INTERACTIVE:
-      fprintf (stdout, "pid: %s\n", buf);
-      break;
-    case STACK_TRACE:
-      pid = fork ();
-      if (pid == 0)
-       {
-         stack_trace (args);
-         _exit (0);
-       }
-      else if (pid == (pid_t) -1)
-       {
-         perror ("could not fork");
-         return;
-       }
-      break;
-    }
+  copy->message = g_strdup (error->message);
 
-  x = 1;
-  while (x)
-    ;
+  return copy;
 }
 
-static void
-stack_trace (char **args)
+/**
+ * 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,
+                 gint          code)
 {
-  pid_t pid;
-  int in_fd[2];
-  int out_fd[2];
-  SELECT_MASK fdset;
-  SELECT_MASK readset;
-  struct timeval tv;
-  int sel, index, state;
-  char buffer[256];
-  char c;
+  return error &&
+    error->domain == domain &&
+    error->code == code;
+}
 
-  stack_trace_done = 0;
-  signal (SIGCHLD, stack_trace_sigchld);
+#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."
+
+/**
+ * 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,
+             gint          code,
+             const gchar  *format,
+             ...)
+{
+  va_list args;
 
-  if ((pipe (in_fd) == -1) || (pipe (out_fd) == -1))
-    {
-      perror ("could open pipe");
-      _exit (0);
-    }
+  if (err == NULL)
+    return;
 
-  pid = fork ();
-  if (pid == 0)
-    {
-      close (0); dup (in_fd[0]);   /* set the stdin to the in pipe */
-      close (1); dup (out_fd[1]);  /* set the stdout to the out pipe */
-      close (2); dup (out_fd[1]);  /* set the stderr to the out pipe */
+  if (*err != NULL)
+    g_warning (ERROR_OVERWRITTEN_WARNING);
+  
+  va_start (args, format);
+  *err = g_error_new_valist (domain, code, format, args);
+  va_end (args);
+}
 
-      execvp (args[0], args);      /* exec gdb */
-      perror ("exec failed");
-      _exit (0);
-    }
-  else if (pid == (pid_t) -1)
+/**
+ * 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)
     {
-      perror ("could not fork");
-      _exit (0);
+      if (src)
+        g_error_free (src);
+      return;
     }
-
-  FD_ZERO (&fdset);
-  FD_SET (out_fd[0], &fdset);
-
-  write (in_fd[1], "backtrace\n", 10);
-  write (in_fd[1], "p x = 0\n", 8);
-  write (in_fd[1], "quit\n", 5);
-
-  index = 0;
-  state = 0;
-
-  while (1)
+  else
     {
-      readset = fdset;
-      tv.tv_sec = 1;
-      tv.tv_usec = 0;
-
-      sel = select (FD_SETSIZE, &readset, NULL, NULL, &tv);
-      if (sel == -1)
-        break;
-
-      if ((sel > 0) && (FD_ISSET (out_fd[0], &readset)))
-        {
-          if (read (out_fd[0], &c, 1))
-            {
-              switch (state)
-                {
-                case 0:
-                  if (c == '#')
-                    {
-                      state = 1;
-                      index = 0;
-                      buffer[index++] = c;
-                    }
-                  break;
-                case 1:
-                  buffer[index++] = c;
-                  if ((c == '\n') || (c == '\r'))
-                    {
-                      buffer[index] = 0;
-                      fprintf (stdout, "%s", buffer);
-                      state = 0;
-                      index = 0;
-                    }
-                  break;
-                default:
-                  break;
-                }
-            }
-        }
-      else if (stack_trace_done)
-        break;
+      if (*dest != NULL)
+        g_warning (ERROR_OVERWRITTEN_WARNING);
+      
+      *dest = src;
     }
-
-  close (in_fd[0]);
-  close (in_fd[1]);
-  close (out_fd[0]);
-  close (out_fd[1]);
-  _exit (0);
 }
 
-static void
-stack_trace_sigchld (int signum)
+/**
+ * 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)
 {
-  stack_trace_done = 1;
+  if (err && *err)
+    {
+      g_error_free (*err);
+      *err = NULL;
+    }
 }