*** empty log message ***
[bpt/guile.git] / libguile / error.c
index fd654d8..78e6986 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996 Free Software Foundation, Inc.
+/*     Copyright (C) 1995,1996,1997,1998 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
@@ -12,7 +12,8 @@
  * 
  * 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, 675 Mass Ave, Cambridge, MA 02139, USA.
+ * 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.
  *
  * 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.  
- */
+ * 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 "validate.h"
 #include "error.h"
 
+#ifdef HAVE_STRING_H
+#include <string.h>
+#endif
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 /* {Errors and Exceptional Conditions}
  */
 
-SCM system_error_sym;
-
-/* True between SCM_DEFER_INTS and SCM_ALLOW_INTS, and
- * when the interpreter is not running at all.
- */
-int scm_ints_disabled = 1;
-
 
 extern int errno;
-#ifdef __STDC__
-static void 
-err_head (char *str)
-#else
-static void 
-err_head (str)
-     char *str;
-#endif
+
+/* All errors should pass through here.  */
+void
+scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
 {
-  int oerrno = errno;
-  if (SCM_NIMP (scm_cur_outp))
-    scm_fflush (scm_cur_outp);
-  scm_gen_putc ('\n', scm_cur_errp);
-#if 0
-  if (SCM_BOOL_F != *scm_loc_loadpath)
-    {
-      scm_iprin1 (*scm_loc_loadpath, scm_cur_errp, 1);
-      scm_gen_puts (scm_regular_string, ", line ", scm_cur_errp);
-      scm_intprint ((long) scm_linum, 10, scm_cur_errp);
-      scm_gen_puts (scm_regular_string, ": ", scm_cur_errp);
-    }
-#endif
-  scm_fflush (scm_cur_errp);
-  errno = oerrno;
-  if (scm_cur_errp == scm_def_errp)
-    {
-      if (errno > 0)
-       perror (str);
-      fflush (stderr);
-      return;
-    }
+  SCM arg_list;
+  arg_list = scm_listify (subr ? scm_makfrom0str (subr) : SCM_BOOL_F,
+                         message ? scm_makfrom0str (message) : SCM_BOOL_F,
+                         args,
+                         rest,
+                         SCM_UNDEFINED);
+  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 rest),
+           "Raise an error with key @var{key}.  @var{subr} can be a string naming\n"
+           "the procedure associated with the error, or @code{#f}.  @var{message}\n"
+           "is the error message string, possibly containing @code{~S} and @code{~A}\n"
+           "escapes.  When an error is reported, these are replaced by formating the\n"
+           "corresponding members of @var{args}: @code{~A} (was @code{%s}) formats using @code{display}\n"
+           "and @code(~S) (was @code{%S}) formats using @code{write}.  @var{data} is a\n"
+           "list or @code{#f} depending on @var{key}: if @var{key} is\n"
+           "@code{system-error} then it should be a list\n"
+           "containing the Unix @code{errno} value;  If @var{key} is @code{signal} then\n"
+           "it should be a list containing the Unix signal number; otherwise it\n"
+           "will usually be @code{#f}.")
+#define FUNC_NAME s_scm_error_scm
+{
+  char *szSubr;
+  char *szMessage;
+  SCM_VALIDATE_SYMBOL (1,key);
+  SCM_VALIDATE_NULLORROSTRING_COPY (2,subr,szSubr);
+  SCM_VALIDATE_NULLORROSTRING_COPY (3,message,szMessage);
+  SCM_COERCE_SUBSTR (message);
 
-SCM_PROC(s_errno, "errno", 0, 1, 0, scm_errno);
-#ifdef __STDC__
-SCM 
-scm_errno (SCM arg)
-#else
-SCM 
-scm_errno (arg)
-     SCM arg;
-#endif
+  scm_error (key, szSubr, szMessage, args, rest);
+  /* not reached.  */
+}
+#undef FUNC_NAME
+
+SCM_DEFINE (scm_strerror, "strerror", 1, 0, 0, 
+            (SCM err),
+           "Returns the Unix error message corresponding to @var{errno}, an integer.")
+#define FUNC_NAME s_scm_strerror
 {
-  int old = errno;
-  if (!SCM_UNBNDP (arg))
-    {
-      if (SCM_FALSEP (arg))
-       errno = 0;
-      else
-       errno = SCM_INUM (arg);
-    }
-  return SCM_MAKINUM (old);
+  SCM_VALIDATE_INUM (1,err);
+  return scm_makfrom0str (strerror (SCM_INUM (err)));
 }
+#undef FUNC_NAME
 
-SCM_PROC(s_perror, "perror", 1, 0, 0, scm_perror);
-#ifdef __STDC__
-SCM 
-scm_perror (SCM arg)
-#else
-SCM 
-scm_perror (arg)
-     SCM arg;
-#endif
+SCM_SYMBOL (scm_system_error_key, "system-error");
+void
+scm_syserror (const char *subr)
 {
-  SCM_ASSERT (SCM_NIMP (arg) && SCM_STRINGP (arg), arg, SCM_ARG1, s_perror);
-  err_head (SCM_CHARS (arg));
-  return SCM_UNSPECIFIED;
+  scm_error (scm_system_error_key,
+            subr,
+            "~A",
+            scm_cons (scm_makfrom0str (strerror (errno)), SCM_EOL),
+            scm_cons (SCM_MAKINUM (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));
+}
 
-#ifdef __STDC__
-void 
-scm_everr (SCM exp, SCM env, SCM arg, char *pos, char *s_subr)
+/* scm_sysmissing is no longer used in libguile.  it can probably be
+   removed after a release or two.  there's a comment in NEWS about it
+   (2000-01-09).  */
+void
+scm_sysmissing (const char *subr)
+{
+#ifdef ENOSYS
+  scm_error (scm_system_error_key,
+            subr,
+            "~A",
+            scm_cons (scm_makfrom0str (strerror (ENOSYS)), SCM_EOL),
+            scm_cons (SCM_MAKINUM (ENOSYS), SCM_EOL));
 #else
-void 
-scm_everr (exp, env, arg, pos, s_subr)
-     SCM exp;
-     SCM env;
-     SCM arg; 
-     char *pos;
-     char *s_subr;
+  scm_error (scm_system_error_key,
+            subr,
+            "Missing function",
+            SCM_BOOL_F,
+            scm_cons (SCM_MAKINUM (0), SCM_EOL));
 #endif
+}
+
+SCM_SYMBOL (scm_num_overflow_key, "numerical-overflow");
+void
+scm_num_overflow (const char *subr)
 {
-  SCM desc;
-  SCM args;
-  
-  if ((~0x1fL) & (long) pos)
-    desc = scm_makfrom0str (pos);
-  else
-    desc = SCM_MAKINUM ((long)pos);
-  
-  {
-    SCM sym;
-    if (!s_subr || !*s_subr)
-      sym = SCM_BOOL_F;
-    else
-      sym = SCM_CAR (scm_intern0 (s_subr));
-    args = scm_listify (desc, sym, arg, SCM_UNDEFINED);
-  }
-  
-  /* (throw (quote %%system-error) <desc> <proc-name> arg)
-   *
-   * <desc> is a string or an integer (see %%system-errors).
-   * <proc-name> is a symbol or #f in some annoying cases (e.g. cddr).
-   */
-  
-  scm_ithrow (system_error_sym, args, 1);
-  
-  /* No return, but just in case: */
+  scm_error (scm_num_overflow_key,
+            subr,
+            "Numerical overflow",
+            SCM_BOOL_F,
+            SCM_BOOL_F);
+}
 
-  write (2, "unhandled system error", sizeof ("unhandled system error") - 1);
-  exit (1);
+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_LIST1(bad_value),
+            SCM_BOOL_F);
 }
 
-#ifdef __STDC__
-SCM
-scm_wta (SCM arg, char *pos, char *s_subr)
-#else
-SCM
-scm_wta (arg, pos, s_subr)
-     SCM arg;
-     char *pos;
-     char *s_subr;
-#endif
+void
+scm_out_of_range_pos (const char *subr, SCM bad_value, SCM pos)
 {
-  scm_everr (SCM_UNDEFINED, SCM_EOL, arg, pos, s_subr);
-  return SCM_UNSPECIFIED;
+  scm_error (scm_out_of_range_key,
+            subr,
+            "Argument ~S out of range: ~S",
+             SCM_LIST2(pos,bad_value),
+            SCM_BOOL_F);
 }
 
-void (*scm_error_callback) () = 0;
 
+SCM_SYMBOL (scm_args_number_key, "wrong-number-of-args");
 void
-scm_error (key, subr, message, args, rest)
-     SCM key;
-     char *subr;
-     char *message;
-     SCM args;
-     SCM rest;
+scm_wrong_num_args (SCM proc)
 {
-  SCM arg_list;
-  if (scm_error_callback)
-    (*scm_error_callback) (key, subr, message, args, rest);
+  scm_error (scm_args_number_key,
+            NULL,
+            "Wrong number of arguments to ~A",
+            SCM_LIST1(proc),
+            SCM_BOOL_F);
+}
 
-  arg_list = scm_listify (scm_makfrom0str (subr),
-                         scm_makfrom0str (message),
-                         args,
-                         rest,
-                         SCM_UNDEFINED);
-  scm_ithrow (key, arg_list, 1);
-  
-  /* No return, but just in case: */
+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_LIST1(bad_value)
+            : SCM_LIST2(SCM_MAKINUM(pos), bad_value),
+            SCM_BOOL_F);
+}
 
-  write (2, "unhandled system error", sizeof ("unhandled system error") - 1);
-  exit (1);
+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_LIST2(msg,bad_value),
+               SCM_BOOL_F);
+  } else {
+    scm_error (scm_arg_type_key,
+               subr,
+               "Wrong type argument in position ~A (expecting ~A): ~S",
+               SCM_LIST3(SCM_MAKINUM(pos),msg,bad_value),
+               SCM_BOOL_F);
+  }
 }
 
-#ifdef __STDC__
+
+SCM_SYMBOL (scm_memory_alloc_key, "memory-allocation-error");
 void
-scm_init_error (void)
-#else
+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);
+}
+
+/* implements the SCM_ASSERT interface.  */  
+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_LIST1 (arg));
+    }
+  else
+    {
+      /* numerical error code.  */
+      int error = (long) 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;
+}
+
 void
 scm_init_error ()
-#endif
 {
-  system_error_sym = scm_permanent_object (SCM_CAR (scm_intern0 ("%%system-error")));
+#include "cpp_err_symbols.c"
 #include "error.x"
 }