Assorted `syntax-check' fixes.
[bpt/guile.git] / libguile / error.c
dissimilarity index 62%
index 0fd2071..4b6bab8 100644 (file)
-/* Copyright (C) 1995,1996,1997,1998,2000,2001 Free Software Foundation, Inc.
- * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program 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 General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
- *
- * This exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
- *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
-
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
-
-\f
-
-#include <stdio.h>
-#include <errno.h>
-
-#include "libguile/_scm.h"
-#include "libguile/pairs.h"
-#include "libguile/strings.h"
-#include "libguile/throw.h"
-
-#include "libguile/validate.h"
-#include "libguile/error.h"
-
-#ifdef HAVE_STRING_H
-#include <string.h>
-#endif
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
-\f
-
-\f
-/* {Errors and Exceptional Conditions}
- */
-
-
-/* All errors should pass through here.  */
-void
-scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
-{
-  SCM arg_list;
-  if (scm_gc_running_p)
-    {
-      /* The error occured during GC --- abort */
-      fprintf (stderr, "Error in %s during GC: %s\n",
-              subr ? subr : "unknown function",
-              message ? message : "<empty message>");
-      abort ();
-    }
-  arg_list = scm_list_4 (subr ? scm_makfrom0str (subr) : SCM_BOOL_F,
-                        message ? scm_makfrom0str (message) : SCM_BOOL_F,
-                        args,
-                        rest);
-  scm_ithrow (key, arg_list, 1);
-  
-  /* No return, but just in case: */
-  {
-    const char msg[] = "guile:scm_error:scm_ithrow returned!\n";
-
-    write (2, msg, (sizeof msg) - 1);
-  }
-  exit (1);
-}
-
-/* Scheme interface to scm_error.  */
-SCM_DEFINE (scm_error_scm, "scm-error", 5, 0, 0, 
-           (SCM key, SCM subr, SCM message, SCM args, SCM data),
-           "Raise an error with key @var{key}.  @var{subr} can be a string\n"
-           "naming the procedure associated with the error, or @code{#f}.\n"
-           "@var{message} is the error message string, possibly containing\n"
-           "@code{~S} and @code{~A} escapes.  When an error is reported,\n"
-           "these are replaced by formatting the corresponding members of\n"
-           "@var{args}: @code{~A} (was @code{%s} in older versions of\n"
-           "Guile) formats using @code{display} and @code{~S} (was\n"
-           "@code{%S}) formats using @code{write}.  @var{data} is a list or\n"
-           "@code{#f} depending on @var{key}: if @var{key} is\n"
-           "@code{system-error} then it should be a list containing the\n"
-           "Unix @code{errno} value; If @var{key} is @code{signal} then it\n"
-           "should be a list containing the Unix signal number; otherwise\n"
-           "it will usually be @code{#f}.")
-#define FUNC_NAME s_scm_error_scm
-{
-  char *szSubr;
-  char *szMessage;
-
-  SCM_VALIDATE_SYMBOL (1, key);
-
-  if (SCM_FALSEP (subr))
-    {
-      szSubr = NULL;
-    }
-  else if (SCM_SYMBOLP (subr))
-    {
-      szSubr = SCM_SYMBOL_CHARS (subr);
-    }
-  else
-    {
-      SCM_VALIDATE_STRING (2, subr);
-      SCM_STRING_COERCE_0TERMINATION_X (subr);
-      szSubr = SCM_STRING_CHARS (subr);
-    }
-
-  if (SCM_FALSEP (message))
-    {
-      szMessage = NULL;
-    }
-  else
-    {
-      SCM_VALIDATE_STRING (2, message);
-      SCM_STRING_COERCE_0TERMINATION_X (message);
-      szMessage = SCM_STRING_CHARS (message);
-    }
-
-  scm_error (key, szSubr, szMessage, args, data);
-  /* not reached.  */
-}
-#undef FUNC_NAME
-
-SCM_DEFINE (scm_strerror, "strerror", 1, 0, 0, 
-            (SCM err),
-           "Return the Unix error message corresponding to @var{err}, which\n"
-           "must be an integer value.")
-#define FUNC_NAME s_scm_strerror
-{
-  SCM_VALIDATE_INUM (1,err);
-  return scm_makfrom0str (strerror (SCM_INUM (err)));
-}
-#undef FUNC_NAME
-
-SCM_SYMBOL (scm_system_error_key, "system-error");
-void
-scm_syserror (const char *subr)
-{
-  int save_errno = errno;
-  
-  scm_error (scm_system_error_key,
-            subr,
-            "~A",
-            scm_cons (scm_makfrom0str (strerror (save_errno)), SCM_EOL),
-            scm_cons (SCM_MAKINUM (save_errno), SCM_EOL));
-}
-
-void
-scm_syserror_msg (const char *subr, const char *message, SCM args, int eno)
-{
-  scm_error (scm_system_error_key,
-            subr,
-            message,
-            args,
-            scm_cons (SCM_MAKINUM (eno), SCM_EOL));
-}
-
-SCM_SYMBOL (scm_num_overflow_key, "numerical-overflow");
-void
-scm_num_overflow (const char *subr)
-{
-  scm_error (scm_num_overflow_key,
-            subr,
-            "Numerical overflow",
-            SCM_BOOL_F,
-            SCM_BOOL_F);
-}
-
-SCM_SYMBOL (scm_out_of_range_key, "out-of-range");
-void
-scm_out_of_range (const char *subr, SCM bad_value)
-{
-  scm_error (scm_out_of_range_key,
-            subr,
-            "Argument out of range: ~S",
-             scm_list_1 (bad_value),
-            SCM_BOOL_F);
-}
-
-void
-scm_out_of_range_pos (const char *subr, SCM bad_value, SCM pos)
-{
-  scm_error (scm_out_of_range_key,
-            subr,
-            "Argument ~S out of range: ~S",
-             scm_list_2 (pos,bad_value),
-            SCM_BOOL_F);
-}
-
-
-SCM_SYMBOL (scm_args_number_key, "wrong-number-of-args");
-void
-scm_wrong_num_args (SCM proc)
-{
-  scm_error (scm_args_number_key,
-            NULL,
-            "Wrong number of arguments to ~A",
-            scm_list_1 (proc),
-            SCM_BOOL_F);
-}
-
-
-void
-scm_error_num_args_subr (const char *subr)
-{
-  scm_error (scm_args_number_key,
-            NULL,
-            "Wrong number of arguments to ~A",
-            scm_list_1 (scm_makfrom0str (subr)),
-            SCM_BOOL_F);
-}
-
-
-SCM_SYMBOL (scm_arg_type_key, "wrong-type-arg");
-void
-scm_wrong_type_arg (const char *subr, int pos, SCM bad_value)
-{
-  scm_error (scm_arg_type_key,
-            subr,
-            (pos == 0) ? "Wrong type argument: ~S"
-            : "Wrong type argument in position ~A: ~S",
-            (pos == 0) ? scm_list_1 (bad_value)
-            : scm_list_2 (SCM_MAKINUM (pos), bad_value),
-            SCM_BOOL_F);
-}
-
-void
-scm_wrong_type_arg_msg (const char *subr, int pos, SCM bad_value, const char *szMessage)
-{
-  SCM msg = scm_makfrom0str(szMessage);
-  if (pos == 0) {
-    scm_error (scm_arg_type_key,
-               subr, "Wrong type argument (expecting ~A): ~S",
-               scm_list_2 (msg, bad_value),
-               SCM_BOOL_F);
-  } else {
-    scm_error (scm_arg_type_key,
-               subr,
-               "Wrong type argument in position ~A (expecting ~A): ~S",
-               scm_list_3 (SCM_MAKINUM (pos), msg, bad_value),
-               SCM_BOOL_F);
-  }
-}
-
-
-SCM_SYMBOL (scm_memory_alloc_key, "memory-allocation-error");
-void
-scm_memory_error (const char *subr)
-{
-  scm_error (scm_memory_alloc_key,
-            subr,
-            "Memory allocation error",
-            SCM_BOOL_F,
-            SCM_BOOL_F);
-}
-
-SCM_SYMBOL (scm_misc_error_key, "misc-error");
-void
-scm_misc_error (const char *subr, const char *message, SCM args)
-{
-  scm_error (scm_misc_error_key, subr, message, args, SCM_BOOL_F);
-}
-
-#if (SCM_DEBUG_DEPRECATED == 0)
-
-SCM
-scm_wta (SCM arg, const char *pos, const char *s_subr)
-{
-  if (!s_subr || !*s_subr)
-    s_subr = NULL;
-  if ((~0x1fL) & (long) pos)
-    {
-      /* error string supplied.  */
-      scm_misc_error (s_subr, pos, scm_list_1 (arg));
-    }
-  else
-    {
-      /* numerical error code.  */
-      int error = (int) pos;
-
-      switch (error)
-       {
-       case SCM_ARGn:
-         scm_wrong_type_arg (s_subr, 0, arg);
-       case SCM_ARG1:
-         scm_wrong_type_arg (s_subr, 1, arg);
-       case SCM_ARG2:
-         scm_wrong_type_arg (s_subr, 2, arg);
-       case SCM_ARG3:
-         scm_wrong_type_arg (s_subr, 3, arg);
-       case SCM_ARG4:
-         scm_wrong_type_arg (s_subr, 4, arg);
-       case SCM_ARG5:
-         scm_wrong_type_arg (s_subr, 5, arg);
-       case SCM_ARG6:
-         scm_wrong_type_arg (s_subr, 6, arg);
-       case SCM_ARG7:
-         scm_wrong_type_arg (s_subr, 7, arg);
-       case SCM_WNA:
-         scm_wrong_num_args (arg);
-       case SCM_OUTOFRANGE:
-         scm_out_of_range (s_subr, arg);
-       case SCM_NALLOC:
-         scm_memory_error (s_subr);
-       default:
-         /* this shouldn't happen.  */
-         scm_misc_error (s_subr, "Unknown error", SCM_EOL);
-       }
-    }
-  return SCM_UNSPECIFIED;
-}
-
-#endif  /* SCM_DEBUG_DEPRECATED == 0 */
-
-void
-scm_init_error ()
-{
-#include "libguile/cpp_err_symbols.c"
-#ifndef SCM_MAGIC_SNARFER
-#include "libguile/error.x"
-#endif
-}
-
-
-/*
-  Local Variables:
-  c-file-style: "gnu"
-  End:
-*/
+/* Copyright (C) 1995,1996,1997,1998,2000,2001, 2004, 2006, 2010 Free Software Foundation, Inc.
+ * 
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public License
+ * as published by the Free Software Foundation; either version 3 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
+ * Lesser General Public License for more details.
+ *
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
+
+
+\f
+
+#ifdef HAVE_CONFIG_H
+#  include <config.h>
+#endif
+
+#include <stdlib.h>
+#include <stdio.h>
+#include <errno.h>
+
+#include "libguile/_scm.h"
+#include "libguile/dynwind.h"
+#include "libguile/pairs.h"
+#include "libguile/strings.h"
+#include "libguile/throw.h"
+
+#include "libguile/validate.h"
+#include "libguile/error.h"
+
+#ifdef HAVE_STRING_H
+#include <string.h>
+#endif
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
+/* For Windows... */
+#ifdef HAVE_IO_H
+#include <io.h>
+#endif
+\f
+
+/* {Errors and Exceptional Conditions}
+ */
+
+
+/* Scheme interface to scm_error_scm.  */
+void
+scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
+{
+  scm_error_scm 
+    (key,
+     (subr == NULL) ? SCM_BOOL_F : scm_from_locale_string (subr),
+     (message == NULL) ? SCM_BOOL_F : scm_from_locale_string (message),
+     args, rest);
+}
+
+/* All errors should pass through here.  */
+SCM_DEFINE (scm_error_scm, "scm-error", 5, 0, 0, 
+           (SCM key, SCM subr, SCM message, SCM args, SCM data),
+           "Raise an error with key @var{key}.  @var{subr} can be a string\n"
+           "naming the procedure associated with the error, or @code{#f}.\n"
+           "@var{message} is the error message string, possibly containing\n"
+           "@code{~S} and @code{~A} escapes.  When an error is reported,\n"
+           "these are replaced by formatting the corresponding members of\n"
+           "@var{args}: @code{~A} (was @code{%s} in older versions of\n"
+           "Guile) formats using @code{display} and @code{~S} (was\n"
+           "@code{%S}) formats using @code{write}.  @var{data} is a list or\n"
+           "@code{#f} depending on @var{key}: if @var{key} is\n"
+           "@code{system-error} then it should be a list containing the\n"
+           "Unix @code{errno} value; If @var{key} is @code{signal} then it\n"
+           "should be a list containing the Unix signal number; If\n"
+           "@var{key} is @code{out-of-range} or @code{wrong-type-arg},\n"
+            "it is a list containing the bad value; otherwise\n"
+           "it will usually be @code{#f}.")
+#define FUNC_NAME s_scm_error_scm
+{
+  if (scm_gc_running_p)
+    {
+      /* The error occured during GC --- abort */
+      fprintf (stderr, "Guile: error during GC.\n"),
+      abort ();
+    }
+
+  scm_ithrow (key, scm_list_4 (subr, message, args, data), 1);
+  
+  /* No return, but just in case: */
+  fprintf (stderr, "Guile scm_ithrow returned!\n");
+  exit (EXIT_FAILURE);
+}
+#undef FUNC_NAME
+
+#ifdef __MINGW32__
+# include "win32-socket.h"
+# define SCM_I_STRERROR(err) \
+    ((err >= WSABASEERR) ? scm_i_socket_strerror (err) : strerror (err))
+# define SCM_I_ERRNO() \
+    (errno ? errno : scm_i_socket_errno ())
+#else
+# define SCM_I_STRERROR(err) strerror (err)
+# define SCM_I_ERRNO() errno
+#endif /* __MINGW32__ */
+
+/* strerror may not be thread safe, for instance in glibc (version 2.3.2) an
+   error number not among the known values results in a string like "Unknown
+   error 9999" formed in a static buffer, which will be overwritten by a
+   similar call in another thread.  A test program running two threads with
+   different unknown error numbers can trip this fairly quickly.
+
+   Some systems don't do what glibc does, instead just giving a single
+   "Unknown error" for unrecognised numbers.  It doesn't seem worth trying
+   to tell if that's the case, a mutex is reasonably fast, and strerror
+   isn't needed very often.
+
+   strerror_r (when available) could be used, it might be a touch faster
+   than a frame and a mutex, though there's probably not much
+   difference.  */
+
+SCM_DEFINE (scm_strerror, "strerror", 1, 0, 0, 
+            (SCM err),
+           "Return the Unix error message corresponding to @var{err}, which\n"
+           "must be an integer value.")
+#define FUNC_NAME s_scm_strerror
+{
+  SCM ret;
+  scm_dynwind_begin (0);
+  scm_i_dynwind_pthread_mutex_lock (&scm_i_misc_mutex);
+
+  ret = scm_from_locale_string (SCM_I_STRERROR (scm_to_int (err)));
+
+  scm_dynwind_end ();
+  return ret;
+}
+#undef FUNC_NAME
+
+SCM_GLOBAL_SYMBOL (scm_system_error_key, "system-error");
+void
+scm_syserror (const char *subr)
+{
+  SCM err = scm_from_int (SCM_I_ERRNO ());
+  scm_error (scm_system_error_key,
+            subr,
+            "~A",
+            scm_cons (scm_strerror (err), SCM_EOL),
+            scm_cons (err, SCM_EOL));
+}
+
+void
+scm_syserror_msg (const char *subr, const char *message, SCM args, int eno)
+{
+  scm_error (scm_system_error_key,
+            subr,
+            message,
+            args,
+            scm_cons (scm_from_int (eno), SCM_EOL));
+}
+
+SCM_GLOBAL_SYMBOL (scm_num_overflow_key, "numerical-overflow");
+void
+scm_num_overflow (const char *subr)
+{
+  scm_error (scm_num_overflow_key,
+            subr,
+            "Numerical overflow",
+            SCM_BOOL_F,
+            SCM_BOOL_F);
+}
+
+SCM_GLOBAL_SYMBOL (scm_out_of_range_key, "out-of-range");
+void
+scm_out_of_range (const char *subr, SCM bad_value)
+{
+  scm_error (scm_out_of_range_key,
+            subr,
+            "Value out of range: ~S",
+             scm_list_1 (bad_value),
+             scm_list_1 (bad_value));
+}
+
+void
+scm_out_of_range_pos (const char *subr, SCM bad_value, SCM pos)
+{
+  scm_error (scm_out_of_range_key,
+            subr,
+            "Argument ~A out of range: ~S",
+             scm_list_2 (pos, bad_value),
+            scm_list_1 (bad_value));
+}
+
+
+SCM_GLOBAL_SYMBOL (scm_args_number_key, "wrong-number-of-args");
+void
+scm_wrong_num_args (SCM proc)
+{
+  scm_error (scm_args_number_key,
+            NULL,
+            "Wrong number of arguments to ~A",
+            scm_list_1 (proc),
+            SCM_BOOL_F);
+}
+
+
+void
+scm_error_num_args_subr (const char *subr)
+{
+  scm_error (scm_args_number_key,
+            NULL,
+            "Wrong number of arguments to ~A",
+            scm_list_1 (scm_from_locale_string (subr)),
+            SCM_BOOL_F);
+}
+
+
+SCM_GLOBAL_SYMBOL (scm_arg_type_key, "wrong-type-arg");
+void
+scm_wrong_type_arg (const char *subr, int pos, SCM bad_value)
+{
+  scm_error (scm_arg_type_key,
+            subr,
+            (pos == 0) ? "Wrong type: ~S"
+            : "Wrong type argument in position ~A: ~S",
+            (pos == 0) ? scm_list_1 (bad_value)
+            : scm_list_2 (scm_from_int (pos), bad_value),
+            scm_list_1 (bad_value));
+}
+
+void
+scm_i_wrong_type_arg_symbol (SCM symbol, int pos, SCM bad_value)
+{
+  scm_error_scm (scm_arg_type_key,
+                scm_symbol_to_string (symbol),
+                (pos == 0) ? scm_from_locale_string ("Wrong type: ~S")
+                : scm_from_locale_string ("Wrong type argument in position ~A: ~S"),
+                (pos == 0) ? scm_list_1 (bad_value)
+                : scm_list_2 (scm_from_int (pos), bad_value),
+                scm_list_1 (bad_value));
+  scm_remember_upto_here_2 (symbol, bad_value);
+}
+
+void
+scm_wrong_type_arg_msg (const char *subr, int pos, SCM bad_value, const char *szMessage)
+{
+  SCM msg = scm_from_locale_string (szMessage);
+  if (pos == 0)
+    {
+      scm_error (scm_arg_type_key,
+                subr, "Wrong type (expecting ~A): ~S",
+                scm_list_2 (msg, bad_value),
+                scm_list_1 (bad_value));
+    }
+  else
+    {
+      scm_error (scm_arg_type_key,
+                subr,
+                "Wrong type argument in position ~A (expecting ~A): ~S",
+                scm_list_3 (scm_from_int (pos), msg, bad_value),
+                scm_list_1 (bad_value));
+    }
+}
+
+
+SCM_GLOBAL_SYMBOL (scm_memory_alloc_key, "memory-allocation-error");
+void
+scm_memory_error (const char *subr)
+{
+  fprintf (stderr, "FATAL: memory error in %s\n", subr);
+  abort ();
+}
+
+SCM_GLOBAL_SYMBOL (scm_misc_error_key, "misc-error");
+void
+scm_misc_error (const char *subr, const char *message, SCM args)
+{
+  scm_error (scm_misc_error_key, subr, message, args, SCM_BOOL_F);
+}
+
+void
+scm_init_error ()
+{
+#include "libguile/cpp-E.c"
+#include "libguile/error.x"
+}
+
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/