* posix.c (getlogin): getlogin() implementation for Windows.
[bpt/guile.git] / libguile / error.c
index a11caba..74e0a5f 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996,1997 Free Software Foundation, Inc.
+/* 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
  * 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 "_scm.h"
-#include "pairs.h"
-#include "genio.h"
-#include "throw.h"
+#include <errno.h>
+
+#include "libguile/_scm.h"
+#include "libguile/pairs.h"
+#include "libguile/strings.h"
+#include "libguile/throw.h"
 
-#include "error.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
 
 \f
  */
 
 
-extern int errno;
-
-void (*scm_error_callback) () = 0;
-
 /* All errors should pass through here.  */
 void
-scm_error (key, subr, message, args, rest)
-     SCM key;
-     char *subr;
-     char *message;
-     SCM args;
-     SCM rest;
+scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
 {
   SCM arg_list;
-  if (scm_error_callback)
-    (*scm_error_callback) (key, subr, message, args, rest);
-
-  arg_list = scm_listify (subr ? scm_makfrom0str (subr) : SCM_BOOL_F,
-                         message ? scm_makfrom0str (message) : SCM_BOOL_F,
-                         args,
-                         rest,
-                         SCM_UNDEFINED);
+  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, "unhandled system error\n",
-        sizeof ("unhandled system error\n") - 1);
+    write (2, msg, (sizeof msg) - 1);
+  }
   exit (1);
 }
 
 /* Scheme interface to scm_error.  */
-SCM_PROC(s_error_scm, "scm-error", 5, 0, 0, scm_error_scm);
-SCM
-scm_error_scm (key, subr, message, args, rest)
-     SCM key;
-     SCM subr;
-     SCM message;
-     SCM args;
-     SCM rest;
+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
 {
-  SCM_ASSERT (SCM_NIMP (key) && SCM_SYMBOLP (key), key, SCM_ARG1, s_error_scm);
-  SCM_ASSERT (SCM_FALSEP (subr) || (SCM_NIMP (subr) && SCM_ROSTRINGP (subr)),
-             subr, SCM_ARG2, s_error_scm);
-  SCM_ASSERT (SCM_FALSEP (message)
-             || (SCM_NIMP (message) && SCM_ROSTRINGP (message)),
-             message, SCM_ARG3, s_error_scm);
-
-  SCM_COERCE_SUBSTR (message);
-
-  scm_error (key,
-            (SCM_FALSEP (subr)) ? NULL : SCM_ROCHARS (subr),
-            (SCM_FALSEP (message)) ? NULL : SCM_ROCHARS (message),
-            args,
-            rest);
+  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 (subr)
-     char *subr;
+scm_syserror (const char *subr)
 {
+  int save_errno = errno;
+  
   scm_error (scm_system_error_key,
             subr,
-            "%s",
-            scm_listify (scm_makfrom0str (strerror (errno)),
-                         SCM_UNDEFINED),
-            scm_listify (SCM_MAKINUM (errno), SCM_UNDEFINED));
+            "~A",
+            scm_cons (scm_makfrom0str (strerror (save_errno)), SCM_EOL),
+            scm_cons (SCM_MAKINUM (save_errno), SCM_EOL));
 }
 
 void
-scm_syserror_msg (subr, message, args, eno)
-     char *subr;
-     char *message;
-     SCM args;
-     int eno;
+scm_syserror_msg (const char *subr, const char *message, SCM args, int eno)
 {
   scm_error (scm_system_error_key,
             subr,
             message,
             args,
-            scm_listify (SCM_MAKINUM (eno), SCM_UNDEFINED));
+            scm_cons (SCM_MAKINUM (eno), SCM_EOL));
 }
 
+SCM_SYMBOL (scm_num_overflow_key, "numerical-overflow");
 void
-scm_sysmissing (subr)
-     char *subr;
+scm_num_overflow (const char *subr)
 {
-#ifdef ENOSYS
-  scm_error (scm_system_error_key,
-            subr,
-            "%s",
-            scm_listify (scm_makfrom0str (strerror (ENOSYS)), SCM_UNDEFINED),
-            scm_listify (SCM_MAKINUM (ENOSYS), SCM_UNDEFINED));
-#else
-  scm_error (scm_system_error_key,
+  scm_error (scm_num_overflow_key,
             subr,
-            "Missing function",
+            "Numerical overflow",
             SCM_BOOL_F,
-            scm_listify (SCM_MAKINUM (0), SCM_UNDEFINED));
-#endif
+            SCM_BOOL_F);
 }
 
-SCM_SYMBOL (scm_num_overflow_key, "numerical-overflow");
+SCM_SYMBOL (scm_out_of_range_key, "out-of-range");
 void
-scm_num_overflow (subr)
-  char *subr;
+scm_out_of_range (const char *subr, SCM bad_value)
 {
-  scm_error (scm_num_overflow_key,
+  scm_error (scm_out_of_range_key,
             subr,
-            "Numerical overflow",
-            SCM_BOOL_F,
+            "Argument out of range: ~S",
+             scm_list_1 (bad_value),
             SCM_BOOL_F);
 }
 
-SCM_SYMBOL (scm_out_of_range_key, "out-of-range");
 void
-scm_out_of_range (subr, bad_value)
-     char *subr;
-     SCM bad_value;
+scm_out_of_range_pos (const char *subr, SCM bad_value, SCM pos)
 {
   scm_error (scm_out_of_range_key,
             subr,
-            "Argument out of range: %S",
-            scm_listify (bad_value, SCM_UNDEFINED),
+            "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 (proc)
-     SCM proc;
+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 %s",
-            scm_listify (proc, SCM_UNDEFINED),
+            "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 (subr, pos, bad_value)
-     char *subr;
-     int pos;
-     SCM bad_value;
+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 %s: %S",
-            (pos == 0) ? scm_listify (bad_value, SCM_UNDEFINED)
-            : scm_listify (SCM_MAKINUM (pos), bad_value, SCM_UNDEFINED),
+            (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 (subr)
-     char *subr;
+scm_memory_error (const char *subr)
 {
   scm_error (scm_memory_alloc_key,
             subr,
@@ -229,32 +290,27 @@ scm_memory_error (subr)
 
 SCM_SYMBOL (scm_misc_error_key, "misc-error");
 void
-scm_misc_error (subr, message, args)
-     char *subr;
-     char *message;
-     SCM args;
+scm_misc_error (const char *subr, const char *message, SCM args)
 {
   scm_error (scm_misc_error_key, subr, message, args, SCM_BOOL_F);
 }
 
-/* implements the SCM_ASSERT interface.  */  
+#if (SCM_DEBUG_DEPRECATED == 0)
+
 SCM
-scm_wta (arg, pos, s_subr)
-     SCM arg;
-     char *pos;
-     char *s_subr;
+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_BOOL_F);
+      scm_misc_error (s_subr, pos, scm_list_1 (arg));
     }
   else
     {
       /* numerical error code.  */
-      int error = (long) pos;
+      int error = (int) pos;
 
       switch (error)
        {
@@ -270,6 +326,10 @@ scm_wta (arg, pos, s_subr)
          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:
@@ -278,19 +338,26 @@ scm_wta (arg, pos, s_subr)
          scm_memory_error (s_subr);
        default:
          /* this shouldn't happen.  */
-         scm_misc_error (s_subr, "Unknown error", SCM_BOOL_F);
+         scm_misc_error (s_subr, "Unknown error", SCM_EOL);
        }
     }
   return SCM_UNSPECIFIED;
 }
 
-/*  obsolete interface: scm_everr (exp, env, arg, pos, s_subr)
-    was equivalent to scm_wta (arg, pos, s_subr)  */
+#endif  /* SCM_DEBUG_DEPRECATED == 0 */
 
 void
 scm_init_error ()
 {
-#include "cpp_err_symbols.c"
-#include "error.x"
+#include "libguile/cpp_err_symbols.c"
+#ifndef SCM_MAGIC_SNARFER
+#include "libguile/error.x"
+#endif
 }
 
+
+/*
+  Local Variables:
+  c-file-style: "gnu"
+  End:
+*/