Correct, update, improve and clean up a lot of docstrings in order to make
[bpt/guile.git] / libguile / error.c
index 2353faf..d8fcc7a 100644 (file)
@@ -1,4 +1,4 @@
-/*     Copyright (C) 1995,1996,1997,1998 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
 \f
 
 #include <stdio.h>
+#include <errno.h>
 
-#include "_scm.h"
-#include "pairs.h"
-#include "genio.h"
-#include "throw.h"
+#include "libguile/_scm.h"
+#include "libguile/pairs.h"
+#include "libguile/strings.h"
+#include "libguile/throw.h"
 
-#include "scm_validate.h"
-#include "error.h"
+#include "libguile/validate.h"
+#include "libguile/error.h"
 
 #ifdef HAVE_STRING_H
 #include <string.h>
  */
 
 
-extern int errno;
-
 /* All errors should pass through here.  */
 void
 scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
 {
   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);
+  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_LIST4 (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: */
@@ -92,35 +98,62 @@ scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
 
 /* 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}.")
+           (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);
-  SCM_VALIDATE_NULLORROSTRING_COPY (2,subr,szSubr);
-  SCM_VALIDATE_NULLORROSTRING_COPY (3,message,szMessage);
-  SCM_COERCE_SUBSTR (message);
 
-  scm_error (key, szSubr, szMessage, args, rest);
+  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),
-           "Returns the Unix error message corresponding to @var{errno}, an integer.")
+           "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);
@@ -132,11 +165,13 @@ 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 (errno)), SCM_EOL),
-            scm_cons (SCM_MAKINUM (errno), SCM_EOL));
+            scm_cons (scm_makfrom0str (strerror (save_errno)), SCM_EOL),
+            scm_cons (SCM_MAKINUM (save_errno), SCM_EOL));
 }
 
 void
@@ -149,6 +184,9 @@ scm_syserror_msg (const char *subr, const char *message, SCM args, int eno)
             scm_cons (SCM_MAKINUM (eno), SCM_EOL));
 }
 
+
+#if (SCM_DEBUG_DEPRECATED == 0)
+
 /* 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).  */
@@ -170,6 +208,9 @@ scm_sysmissing (const char *subr)
 #endif
 }
 
+#endif  /* SCM_DEBUG_DEPRECATED == 0 */
+
+
 SCM_SYMBOL (scm_num_overflow_key, "numerical-overflow");
 void
 scm_num_overflow (const char *subr)
@@ -188,7 +229,7 @@ scm_out_of_range (const char *subr, SCM bad_value)
   scm_error (scm_out_of_range_key,
             subr,
             "Argument out of range: ~S",
-            scm_cons (bad_value, SCM_EOL),
+             SCM_LIST1(bad_value),
             SCM_BOOL_F);
 }
 
@@ -198,7 +239,7 @@ 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_listify (pos, bad_value, SCM_UNDEFINED),
+             SCM_LIST2(pos,bad_value),
             SCM_BOOL_F);
 }
 
@@ -210,10 +251,22 @@ scm_wrong_num_args (SCM proc)
   scm_error (scm_args_number_key,
             NULL,
             "Wrong number of arguments to ~A",
-            scm_cons (proc, SCM_EOL),
+            SCM_LIST1(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_LIST1 (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)
@@ -222,11 +275,30 @@ scm_wrong_type_arg (const char *subr, int pos, SCM bad_value)
             subr,
             (pos == 0) ? "Wrong type argument: ~S"
             : "Wrong type argument in position ~A: ~S",
-            (pos == 0) ? scm_cons (bad_value, SCM_EOL)
-            : scm_cons (SCM_MAKINUM (pos), scm_cons (bad_value, SCM_EOL)),
+            (pos == 0) ? SCM_LIST1(bad_value)
+            : SCM_LIST2(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_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);
+  }
+}
+
+
 SCM_SYMBOL (scm_memory_alloc_key, "memory-allocation-error");
 void
 scm_memory_error (const char *subr)
@@ -245,7 +317,8 @@ 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 (SCM arg, const char *pos, const char *s_subr)
 {
@@ -293,10 +366,20 @@ scm_wta (SCM arg, const char *pos, const char *s_subr)
   return SCM_UNSPECIFIED;
 }
 
+#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:
+*/