libguile/error.c

   1 /* Copyright (C) 1995,1996,1997,1998,2000,2001 Free Software Foundation, Inc.
   2  *
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2, or (at your option)
   6  * any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this software; see the file COPYING.  If not, write to
  15  * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  16  * Boston, MA 02111-1307 USA
  17  *
  18  * As a special exception, the Free Software Foundation gives permission
  19  * for additional uses of the text contained in its release of GUILE.
  20  *
  21  * The exception is that, if you link the GUILE library with other files
  22  * to produce an executable, this does not by itself cause the
  23  * resulting executable to be covered by the GNU General Public License.
  24  * Your use of that executable is in no way restricted on account of
  25  * linking the GUILE library code into it.
  26  *
  27  * This exception does not however invalidate any other reasons why
  28  * the executable file might be covered by the GNU General Public License.
  29  *
  30  * This exception applies only to the code released by the
  31  * Free Software Foundation under the name GUILE.  If you copy
  32  * code from other Free Software Foundation releases into a copy of
  33  * GUILE, as the General Public License permits, the exception does
  34  * not apply to the code that you add in this way.  To avoid misleading
  35  * anyone as to the status of such modified files, you must delete
  36  * this exception notice from them.
  37  *
  38  * If you write modifications of your own for GUILE, it is your choice
  39  * whether to permit this exception to apply to your modifications.
  40  * If you do not wish that, delete this exception notice.  */
  41
  42 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
  43    gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
  44
  45 \f
  46
  47 #include <stdio.h>
  48 #include <errno.h>
  49
  50 #include "libguile/_scm.h"
  51 #include "libguile/pairs.h"
  52 #include "libguile/strings.h"
  53 #include "libguile/throw.h"
  54
  55 #include "libguile/validate.h"
  56 #include "libguile/error.h"
  57
  58 #ifdef HAVE_STRING_H
  59 #include <string.h>
  60 #endif
  61 #ifdef HAVE_UNISTD_H
  62 #include <unistd.h>
  63 #endif
  64 \f
  65
  66 \f
  67 /* {Errors and Exceptional Conditions}
  68  */
  69
  70
  71 /* All errors should pass through here.  */
  72 void
  73 scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
  74 {
  75   SCM arg_list;
  76   if (scm_gc_running_p)
  77     {
  78       /* The error occured during GC --- abort */
  79       fprintf (stderr, "Error in %s during GC: %s\n",
  80                subr ? subr : "unknown function",
  81                message ? message : "<empty message>");
  82       abort ();
  83     }
  84   arg_list = SCM_LIST4 (subr ? scm_makfrom0str (subr) : SCM_BOOL_F,
  85                         message ? scm_makfrom0str (message) : SCM_BOOL_F,
  86                         args,
  87                         rest);
  88   scm_ithrow (key, arg_list, 1);
  89
  90   /* No return, but just in case: */
  91   {
  92     const char msg[] = "guile:scm_error:scm_ithrow returned!\n";
  93
  94     write (2, msg, (sizeof msg) - 1);
  95   }
  96   exit (1);
  97 }
  98
  99 /* Scheme interface to scm_error.  */
 100 SCM_DEFINE (scm_error_scm, "scm-error", 5, 0, 0,
 101            (SCM key, SCM subr, SCM message, SCM args, SCM rest),
 102             "Raise an error with key @var{key}.  @var{subr} can be a string naming\n"
 103             "the procedure associated with the error, or @code{#f}.  @var{message}\n"
 104             "is the error message string, possibly containing @code{~S} and @code{~A}\n"
 105             "escapes.  When an error is reported, these are replaced by formating the\n"
 106             "corresponding members of @var{args}: @code{~A} (was @code{%s}) formats using @code{display}\n"
 107             "and @code{~S} (was @code{%S}) formats using @code{write}.  @var{data} is a\n"
 108             "list or @code{#f} depending on @var{key}: if @var{key} is\n"
 109             "@code{system-error} then it should be a list\n"
 110             "containing the Unix @code{errno} value;  If @var{key} is @code{signal} then\n"
 111             "it should be a list containing the Unix signal number; otherwise it\n"
 112             "will usually be @code{#f}.")
 113 #define FUNC_NAME s_scm_error_scm
 114 {
 115   char *szSubr;
 116   char *szMessage;
 117
 118   SCM_VALIDATE_SYMBOL (1, key);
 119
 120   if (SCM_FALSEP (subr))
 121     {
 122       szSubr = NULL;
 123     }
 124   else if (SCM_SYMBOLP (subr))
 125     {
 126       szSubr = SCM_SYMBOL_CHARS (subr);
 127     }
 128   else
 129     {
 130       SCM_VALIDATE_STRING (2, subr);
 131       SCM_STRING_COERCE_0TERMINATION_X (subr);
 132       szSubr = SCM_STRING_CHARS (subr);
 133     }
 134
 135   if (SCM_FALSEP (message))
 136     {
 137       szMessage = NULL;
 138     }
 139   else
 140     {
 141       SCM_VALIDATE_STRING (2, message);
 142       SCM_STRING_COERCE_0TERMINATION_X (message);
 143       szMessage = SCM_STRING_CHARS (message);
 144     }
 145
 146   scm_error (key, szSubr, szMessage, args, rest);
 147   /* not reached.  */
 148 }
 149 #undef FUNC_NAME
 150
 151 SCM_DEFINE (scm_strerror, "strerror", 1, 0, 0,
 152             (SCM err),
 153             "Returns the Unix error message corresponding to @var{err}, an integer.")
 154 #define FUNC_NAME s_scm_strerror
 155 {
 156   SCM_VALIDATE_INUM (1,err);
 157   return scm_makfrom0str (strerror (SCM_INUM (err)));
 158 }
 159 #undef FUNC_NAME
 160
 161 SCM_SYMBOL (scm_system_error_key, "system-error");
 162 void
 163 scm_syserror (const char *subr)
 164 {
 165   int save_errno = errno;
 166
 167   scm_error (scm_system_error_key,
 168              subr,
 169              "~A",
 170              scm_cons (scm_makfrom0str (strerror (save_errno)), SCM_EOL),
 171              scm_cons (SCM_MAKINUM (save_errno), SCM_EOL));
 172 }
 173
 174 void
 175 scm_syserror_msg (const char *subr, const char *message, SCM args, int eno)
 176 {
 177   scm_error (scm_system_error_key,
 178              subr,
 179              message,
 180              args,
 181              scm_cons (SCM_MAKINUM (eno), SCM_EOL));
 182 }
 183
 184
 185 #if (SCM_DEBUG_DEPRECATED == 0)
 186
 187 /* scm_sysmissing is no longer used in libguile.  it can probably be
 188    removed after a release or two.  there's a comment in NEWS about it
 189    (2000-01-09).  */
 190 void
 191 scm_sysmissing (const char *subr)
 192 {
 193 #ifdef ENOSYS
 194   scm_error (scm_system_error_key,
 195              subr,
 196              "~A",
 197              scm_cons (scm_makfrom0str (strerror (ENOSYS)), SCM_EOL),
 198              scm_cons (SCM_MAKINUM (ENOSYS), SCM_EOL));
 199 #else
 200   scm_error (scm_system_error_key,
 201              subr,
 202              "Missing function",
 203              SCM_BOOL_F,
 204              scm_cons (SCM_MAKINUM (0), SCM_EOL));
 205 #endif
 206 }
 207
 208 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 209
 210
 211 SCM_SYMBOL (scm_num_overflow_key, "numerical-overflow");
 212 void
 213 scm_num_overflow (const char *subr)
 214 {
 215   scm_error (scm_num_overflow_key,
 216              subr,
 217              "Numerical overflow",
 218              SCM_BOOL_F,
 219              SCM_BOOL_F);
 220 }
 221
 222 SCM_SYMBOL (scm_out_of_range_key, "out-of-range");
 223 void
 224 scm_out_of_range (const char *subr, SCM bad_value)
 225 {
 226   scm_error (scm_out_of_range_key,
 227              subr,
 228              "Argument out of range: ~S",
 229              SCM_LIST1(bad_value),
 230              SCM_BOOL_F);
 231 }
 232
 233 void
 234 scm_out_of_range_pos (const char *subr, SCM bad_value, SCM pos)
 235 {
 236   scm_error (scm_out_of_range_key,
 237              subr,
 238              "Argument ~S out of range: ~S",
 239              SCM_LIST2(pos,bad_value),
 240              SCM_BOOL_F);
 241 }
 242
 243
 244 SCM_SYMBOL (scm_args_number_key, "wrong-number-of-args");
 245 void
 246 scm_wrong_num_args (SCM proc)
 247 {
 248   scm_error (scm_args_number_key,
 249              NULL,
 250              "Wrong number of arguments to ~A",
 251              SCM_LIST1(proc),
 252              SCM_BOOL_F);
 253 }
 254
 255
 256 void
 257 scm_error_num_args_subr (const char *subr)
 258 {
 259   scm_error (scm_args_number_key,
 260              NULL,
 261              "Wrong number of arguments to ~A",
 262              SCM_LIST1 (scm_makfrom0str (subr)),
 263              SCM_BOOL_F);
 264 }
 265
 266
 267 SCM_SYMBOL (scm_arg_type_key, "wrong-type-arg");
 268 void
 269 scm_wrong_type_arg (const char *subr, int pos, SCM bad_value)
 270 {
 271   scm_error (scm_arg_type_key,
 272              subr,
 273              (pos == 0) ? "Wrong type argument: ~S"
 274              : "Wrong type argument in position ~A: ~S",
 275              (pos == 0) ? SCM_LIST1(bad_value)
 276              : SCM_LIST2(SCM_MAKINUM(pos), bad_value),
 277              SCM_BOOL_F);
 278 }
 279
 280 void
 281 scm_wrong_type_arg_msg (const char *subr, int pos, SCM bad_value, const char *szMessage)
 282 {
 283   SCM msg = scm_makfrom0str(szMessage);
 284   if (pos == 0) {
 285     scm_error (scm_arg_type_key,
 286                subr, "Wrong type argument (expecting ~A): ~S",
 287                SCM_LIST2(msg,bad_value),
 288                SCM_BOOL_F);
 289   } else {
 290     scm_error (scm_arg_type_key,
 291                subr,
 292                "Wrong type argument in position ~A (expecting ~A): ~S",
 293                SCM_LIST3(SCM_MAKINUM(pos),msg,bad_value),
 294                SCM_BOOL_F);
 295   }
 296 }
 297
 298
 299 SCM_SYMBOL (scm_memory_alloc_key, "memory-allocation-error");
 300 void
 301 scm_memory_error (const char *subr)
 302 {
 303   scm_error (scm_memory_alloc_key,
 304              subr,
 305              "Memory allocation error",
 306              SCM_BOOL_F,
 307              SCM_BOOL_F);
 308 }
 309
 310 SCM_SYMBOL (scm_misc_error_key, "misc-error");
 311 void
 312 scm_misc_error (const char *subr, const char *message, SCM args)
 313 {
 314   scm_error (scm_misc_error_key, subr, message, args, SCM_BOOL_F);
 315 }
 316
 317 /* implements the SCM_ASSERT interface.  */
 318 SCM
 319 scm_wta (SCM arg, const char *pos, const char *s_subr)
 320 {
 321   if (!s_subr || !*s_subr)
 322     s_subr = NULL;
 323   if ((~0x1fL) & (long) pos)
 324     {
 325       /* error string supplied.  */
 326       scm_misc_error (s_subr, pos, SCM_LIST1 (arg));
 327     }
 328   else
 329     {
 330       /* numerical error code.  */
 331       int error = (long) pos;
 332
 333       switch (error)
 334         {
 335         case SCM_ARGn:
 336           scm_wrong_type_arg (s_subr, 0, arg);
 337         case SCM_ARG1:
 338           scm_wrong_type_arg (s_subr, 1, arg);
 339         case SCM_ARG2:
 340           scm_wrong_type_arg (s_subr, 2, arg);
 341         case SCM_ARG3:
 342           scm_wrong_type_arg (s_subr, 3, arg);
 343         case SCM_ARG4:
 344           scm_wrong_type_arg (s_subr, 4, arg);
 345         case SCM_ARG5:
 346           scm_wrong_type_arg (s_subr, 5, arg);
 347         case SCM_ARG6:
 348           scm_wrong_type_arg (s_subr, 6, arg);
 349         case SCM_ARG7:
 350           scm_wrong_type_arg (s_subr, 7, arg);
 351         case SCM_WNA:
 352           scm_wrong_num_args (arg);
 353
 354 #if (SCM_DEBUG_DEPRECATED == 0)
 355
 356         case SCM_OUTOFRANGE:
 357           scm_out_of_range (s_subr, arg);
 358         case SCM_NALLOC:
 359           scm_memory_error (s_subr);
 360
 361 #endif  /* SCM_DEBUG_DEPRECATED == 0 */
 362
 363         default:
 364           /* this shouldn't happen.  */
 365           scm_misc_error (s_subr, "Unknown error", SCM_EOL);
 366         }
 367     }
 368   return SCM_UNSPECIFIED;
 369 }
 370
 371 void
 372 scm_init_error ()
 373 {
 374 #include "libguile/cpp_err_symbols.c"
 375 #ifndef SCM_MAGIC_SNARFER
 376 #include "libguile/error.x"
 377 #endif
 378 }
 379
 380
 381 /*
 382   Local Variables:
 383   c-file-style: "gnu"
 384   End:
 385 */