[bpt/guile.git] / libguile / error.c

/*	Copyright (C) 1995,1996 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, 675 Mass Ave, Cambridge, MA 02139, 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.  
 */
\f

#include <stdio.h>
#include "_scm.h"
#include "pairs.h"
#include "genio.h"
#include "throw.h"

#include "error.h"

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
\f

\f
/* {Errors and Exceptional Conditions}
 */


/* 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;

static void 
err_head (str)
     char *str;
{
  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_prin1 (*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_PROC(s_errno, "errno", 0, 1, 0, scm_errno);
SCM
scm_errno (arg)
     SCM arg;
{
  int old = errno;
  if (!SCM_UNBNDP (arg))
    {
      if (SCM_FALSEP (arg))
	errno = 0;
      else
	errno = SCM_INUM (arg);
    }
  return SCM_MAKINUM (old);
}

SCM_PROC(s_perror, "perror", 1, 0, 0, scm_perror);
SCM 
scm_perror (arg)
     SCM arg;
{
  SCM_ASSERT (SCM_NIMP (arg) && SCM_STRINGP (arg), arg, SCM_ARG1, s_perror);
  err_head (SCM_CHARS (arg));
  return SCM_UNSPECIFIED;
}

void (*scm_error_callback) () = 0;

/* all errors thrown from C should pass through here.  */
/* also known as scm_error.  */
void
scm_error (key, subr, message, args, rest)
     SCM key;
     char *subr;
     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);
  scm_ithrow (key, arg_list, 1);
  
  /* No return, but just in case: */

  write (2, "unhandled system error", sizeof ("unhandled system error") - 1);
  exit (1);
}

/* error keys: defined here, initialized below, prototyped in error.h,
   associated with handler procedures in boot-9.scm.  */
SCM scm_system_error_key;
SCM scm_num_overflow_key;
SCM scm_out_of_range_key;
SCM scm_arg_type_key;
SCM scm_args_number_key;
SCM scm_memory_alloc_key;
SCM scm_stack_overflow_key;
SCM scm_misc_error_key;

void
scm_syserror (subr)
     char *subr;
{
  scm_error (scm_system_error_key,
	     subr,
	     "%s",
	     scm_listify (scm_makfrom0str (strerror (errno)),
			  SCM_UNDEFINED),
	     scm_listify (SCM_MAKINUM (errno), SCM_UNDEFINED));
}

void
scm_syserror_msg (subr, message, args)
     char *subr;
     char *message;
     SCM args;
{
  scm_error (scm_system_error_key,
	     subr,
	     message,
	     args,
	     scm_listify (SCM_MAKINUM (errno), SCM_UNDEFINED));
}

void
scm_sysmissing (subr)
     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,
	     subr,
	     "Missing function",
	     SCM_BOOL_F,
	     scm_listify (SCM_MAKINUM (0), SCM_UNDEFINED));
#endif
}

void
scm_num_overflow (subr)
  char *subr;
{
  scm_error (scm_num_overflow_key,
	     subr,
	     "Numerical overflow",
	     SCM_BOOL_F,
	     SCM_BOOL_F);
}

void
scm_out_of_range (subr, bad_value)
     char *subr;
     SCM bad_value;
{
  scm_error (scm_out_of_range_key,
	     subr,
	     "Argument out of range: %S",
	     scm_listify (bad_value, SCM_UNDEFINED),
	     SCM_BOOL_F);
}

void
scm_wrong_num_args (proc)
     SCM proc;
{
  scm_error (scm_args_number_key,
	     NULL,
	     "Wrong number of arguments to %s",
	     scm_listify (proc, SCM_UNDEFINED),
	     SCM_BOOL_F);
}

void
scm_wrong_type_arg (subr, pos, bad_value)
     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),
	     SCM_BOOL_F);
}

void
scm_memory_error (subr)
     char *subr;
{
  scm_error (scm_memory_alloc_key,
	     subr,
	     "Memory allocation error",
	     SCM_BOOL_F,
	     SCM_BOOL_F);
}

/* implements the SCM_ASSERT interface.  */  
SCM
scm_wta (arg, pos, s_subr)
     SCM arg;
     char *pos;
     char *s_subr;
{
  if (!s_subr || !*s_subr)
    s_subr = NULL;
  if ((~0x1fL) & (long) pos)
    {
      /* error string supplied.  */
      scm_error (scm_misc_error_key,
		 s_subr,
		 pos,
		 SCM_BOOL_F,
		 SCM_BOOL_F);
    }
  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_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_error (scm_misc_error_key,
		     s_subr,
		     "Unknown error",
		     SCM_BOOL_F,
		     SCM_BOOL_F);
	}
    }
  return SCM_UNSPECIFIED;
}

/*  obsolete interface: scm_everr (exp, env, arg, pos, s_subr)
    was equivalent to scm_wta (arg, pos, s_subr)  */

void
scm_init_error ()
{
  scm_system_error_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("system-error")));
  scm_num_overflow_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("numerical-overflow")));
  scm_out_of_range_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("out-of-range")));
  scm_arg_type_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("wrong-type-arg")));
  scm_args_number_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("wrong-number-of-args")));
  scm_memory_alloc_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("memory-allocation-error")));
  scm_stack_overflow_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("stack-overflow")));
  scm_misc_error_key
    = scm_permanent_object (SCM_CAR (scm_intern0 ("misc-error")));
#include "error.x"
}
Commit	Line	Data
0f2d19dd JB	1	/* Copyright (C) 1995,1996 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, 675 Mass Ave, Cambridge, MA 02139, USA.
	16	*
	17	* As a special exception, the Free Software Foundation gives permission
	18	* for additional uses of the text contained in its release of GUILE.
	19	*
	20	* The exception is that, if you link the GUILE library with other files
	21	* to produce an executable, this does not by itself cause the
	22	* resulting executable to be covered by the GNU General Public License.
	23	* Your use of that executable is in no way restricted on account of
	24	* linking the GUILE library code into it.
	25	*
	26	* This exception does not however invalidate any other reasons why
	27	* the executable file might be covered by the GNU General Public License.
	28	*
	29	* This exception applies only to the code released by the
	30	* Free Software Foundation under the name GUILE. If you copy
	31	* code from other Free Software Foundation releases into a copy of
	32	* GUILE, as the General Public License permits, the exception does
	33	* not apply to the code that you add in this way. To avoid misleading
	34	* anyone as to the status of such modified files, you must delete
	35	* this exception notice from them.
	36	*
	37	* If you write modifications of your own for GUILE, it is your choice
	38	* whether to permit this exception to apply to your modifications.
	39	* If you do not wish that, delete this exception notice.
	40	*/
	41	\f
	42
	43	#include <stdio.h>
	44	#include "_scm.h"
20e6290e JB	45	#include "pairs.h"
	46	#include "genio.h"
	47	#include "throw.h"
	48
	49	#include "error.h"
0f2d19dd	50
95b88819 GH	51	#ifdef HAVE_UNISTD_H
	52	#include <unistd.h>
	53	#endif
0f2d19dd JB	54	\f
	55
	56	\f
	57	/* {Errors and Exceptional Conditions}
	58	*/
	59
0f2d19dd JB	60
	61	/* True between SCM_DEFER_INTS and SCM_ALLOW_INTS, and
	62	* when the interpreter is not running at all.
	63	*/
	64	int scm_ints_disabled = 1;
	65
0f2d19dd	66	extern int errno;
f5bf2977	67
0f2d19dd JB	68	static void
	69	err_head (str)
	70	char *str;
0f2d19dd JB	71	{
	72	int oerrno = errno;
	73	if (SCM_NIMP (scm_cur_outp))
	74	scm_fflush (scm_cur_outp);
	75	scm_gen_putc ('\n', scm_cur_errp);
	76	#if 0
	77	if (SCM_BOOL_F != *scm_loc_loadpath)
	78	{
a25840f9	79	scm_prin1 (*scm_loc_loadpath, scm_cur_errp, 1);
0f2d19dd JB	80	scm_gen_puts (scm_regular_string, ", line ", scm_cur_errp);
	81	scm_intprint ((long) scm_linum, 10, scm_cur_errp);
	82	scm_gen_puts (scm_regular_string, ": ", scm_cur_errp);
	83	}
	84	#endif
	85	scm_fflush (scm_cur_errp);
	86	errno = oerrno;
	87	if (scm_cur_errp == scm_def_errp)
	88	{
	89	if (errno > 0)
	90	perror (str);
	91	fflush (stderr);
	92	return;
	93	}
	94	}
	95
	96
	97	SCM_PROC(s_errno, "errno", 0, 1, 0, scm_errno);
f5bf2977	98	SCM
0f2d19dd JB	99	scm_errno (arg)
0f2d19dd JB	100	SCM arg;
0f2d19dd JB	101	{
	102	int old = errno;
	103	if (!SCM_UNBNDP (arg))
	104	{
	105	if (SCM_FALSEP (arg))
	106	errno = 0;
	107	else
	108	errno = SCM_INUM (arg);
	109	}
	110	return SCM_MAKINUM (old);
	111	}
	112
	113	SCM_PROC(s_perror, "perror", 1, 0, 0, scm_perror);
0f2d19dd JB	114	SCM
	115	scm_perror (arg)
	116	SCM arg;
0f2d19dd JB	117	{
	118	SCM_ASSERT (SCM_NIMP (arg) && SCM_STRINGP (arg), arg, SCM_ARG1, s_perror);
	119	err_head (SCM_CHARS (arg));
	120	return SCM_UNSPECIFIED;
	121	}
	122
7cb1d4d3	123	void (*scm_error_callback) () = 0;
0f2d19dd	124
f5bf2977	125	/* all errors thrown from C should pass through here. */
01f61221	126	/* also known as scm_error. */
7cb1d4d3 GH	127	void
	128	scm_error (key, subr, message, args, rest)
	129	SCM key;
	130	char *subr;
	131	char *message;
	132	SCM args;
	133	SCM rest;
	134	{
	135	SCM arg_list;
	136	if (scm_error_callback)
	137	(*scm_error_callback) (key, subr, message, args, rest);
	138
f5bf2977	139	arg_list = scm_listify (subr ? scm_makfrom0str (subr) : SCM_BOOL_F,
b59b97ba	140	message ? scm_makfrom0str (message) : SCM_BOOL_F,
7cb1d4d3 GH	141	args,
	142	rest,
	143	SCM_UNDEFINED);
	144	scm_ithrow (key, arg_list, 1);
	145
	146	/* No return, but just in case: */
	147
	148	write (2, "unhandled system error", sizeof ("unhandled system error") - 1);
	149	exit (1);
	150	}
0f2d19dd	151
e1724d20 GH	152	/* error keys: defined here, initialized below, prototyped in error.h,
e1724d20 GH	153	associated with handler procedures in boot-9.scm. */
52859adf GH	154	SCM scm_system_error_key;
	155	SCM scm_num_overflow_key;
	156	SCM scm_out_of_range_key;
f5bf2977 GH	157	SCM scm_arg_type_key;
	158	SCM scm_args_number_key;
	159	SCM scm_memory_alloc_key;
	160	SCM scm_stack_overflow_key;
	161	SCM scm_misc_error_key;
e1724d20	162
52859adf GH	163	void
	164	scm_syserror (subr)
	165	char *subr;
	166	{
01f61221	167	scm_error (scm_system_error_key,
52859adf	168	subr,
f5bf2977	169	"%s",
52859adf GH	170	scm_listify (scm_makfrom0str (strerror (errno)),
	171	SCM_UNDEFINED),
	172	scm_listify (SCM_MAKINUM (errno), SCM_UNDEFINED));
	173	}
	174
	175	void
	176	scm_syserror_msg (subr, message, args)
	177	char *subr;
	178	char *message;
	179	SCM args;
	180	{
01f61221	181	scm_error (scm_system_error_key,
52859adf GH	182	subr,
	183	message,
	184	args,
	185	scm_listify (SCM_MAKINUM (errno), SCM_UNDEFINED));
	186	}
	187
	188	void
	189	scm_sysmissing (subr)
	190	char *subr;
	191	{
	192	#ifdef ENOSYS
01f61221	193	scm_error (scm_system_error_key,
52859adf	194	subr,
f5bf2977	195	"%s",
52859adf GH	196	scm_listify (scm_makfrom0str (strerror (ENOSYS)), SCM_UNDEFINED),
	197	scm_listify (SCM_MAKINUM (ENOSYS), SCM_UNDEFINED));
	198	#else
01f61221	199	scm_error (scm_system_error_key,
52859adf GH	200	subr,
	201	"Missing function",
	202	SCM_BOOL_F,
	203	scm_listify (SCM_MAKINUM (0), SCM_UNDEFINED));
	204	#endif
	205	}
	206
	207	void
	208	scm_num_overflow (subr)
	209	char *subr;
	210	{
01f61221	211	scm_error (scm_num_overflow_key,
52859adf GH	212	subr,
	213	"Numerical overflow",
	214	SCM_BOOL_F,
	215	SCM_BOOL_F);
	216	}
	217
	218	void
	219	scm_out_of_range (subr, bad_value)
	220	char *subr;
	221	SCM bad_value;
	222	{
01f61221	223	scm_error (scm_out_of_range_key,
52859adf GH	224	subr,
	225	"Argument out of range: %S",
	226	scm_listify (bad_value, SCM_UNDEFINED),
	227	SCM_BOOL_F);
	228	}
f5bf2977	229
0f2d19dd	230	void
f5bf2977 GH	231	scm_wrong_num_args (proc)
	232	SCM proc;
	233	{
01f61221	234	scm_error (scm_args_number_key,
f5bf2977 GH	235	NULL,
	236	"Wrong number of arguments to %s",
	237	scm_listify (proc, SCM_UNDEFINED),
	238	SCM_BOOL_F);
	239	}
	240
	241	void
	242	scm_wrong_type_arg (subr, pos, bad_value)
	243	char *subr;
	244	int pos;
	245	SCM bad_value;
	246	{
01f61221	247	scm_error (scm_arg_type_key,
f5bf2977 GH	248	subr,
	249	(pos == 0) ? "Wrong type argument: %S"
	250	: "Wrong type argument in position %s: %S",
	251	(pos == 0) ? scm_listify (bad_value, SCM_UNDEFINED)
	252	: scm_listify (SCM_MAKINUM (pos), bad_value, SCM_UNDEFINED),
	253	SCM_BOOL_F);
	254	}
	255
	256	void
	257	scm_memory_error (subr)
	258	char *subr;
	259	{
01f61221	260	scm_error (scm_memory_alloc_key,
f5bf2977 GH	261	subr,
	262	"Memory allocation error",
	263	SCM_BOOL_F,
	264	SCM_BOOL_F);
	265	}
	266
	267	/* implements the SCM_ASSERT interface. */
	268	SCM
	269	scm_wta (arg, pos, s_subr)
	270	SCM arg;
	271	char *pos;
	272	char *s_subr;
	273	{
	274	if (!s_subr \|\| !*s_subr)
	275	s_subr = NULL;
	276	if ((~0x1fL) & (long) pos)
	277	{
	278	/* error string supplied. */
01f61221	279	scm_error (scm_misc_error_key,
f5bf2977 GH	280	s_subr,
	281	pos,
	282	SCM_BOOL_F,
	283	SCM_BOOL_F);
	284	}
	285	else
	286	{
	287	/* numerical error code. */
	288	int error = (long) pos;
	289
	290	switch (error)
	291	{
	292	case SCM_ARGn:
	293	scm_wrong_type_arg (s_subr, 0, arg);
	294	case SCM_ARG1:
	295	scm_wrong_type_arg (s_subr, 1, arg);
	296	case SCM_ARG2:
	297	scm_wrong_type_arg (s_subr, 2, arg);
	298	case SCM_ARG3:
	299	scm_wrong_type_arg (s_subr, 3, arg);
	300	case SCM_ARG4:
	301	scm_wrong_type_arg (s_subr, 4, arg);
	302	case SCM_ARG5:
	303	scm_wrong_type_arg (s_subr, 5, arg);
	304	case SCM_WNA:
	305	scm_wrong_num_args (arg);
	306	case SCM_OUTOFRANGE:
	307	scm_out_of_range (s_subr, arg);
	308	case SCM_NALLOC:
	309	scm_memory_error (s_subr);
	310	default:
	311	/* this shouldn't happen. */
01f61221	312	scm_error (scm_misc_error_key,
f5bf2977 GH	313	s_subr,
	314	"Unknown error",
	315	SCM_BOOL_F,
	316	SCM_BOOL_F);
	317	}
	318	}
	319	return SCM_UNSPECIFIED;
	320	}
	321
	322	/* obsolete interface: scm_everr (exp, env, arg, pos, s_subr)
	323	was equivalent to scm_wta (arg, pos, s_subr) */
	324
0f2d19dd JB	325	void
0f2d19dd JB	326	scm_init_error ()
0f2d19dd	327	{
52859adf	328	scm_system_error_key
e1724d20	329	= scm_permanent_object (SCM_CAR (scm_intern0 ("system-error")));
52859adf	330	scm_num_overflow_key
e1724d20	331	= scm_permanent_object (SCM_CAR (scm_intern0 ("numerical-overflow")));
52859adf GH	332	scm_out_of_range_key
52859adf GH	333	= scm_permanent_object (SCM_CAR (scm_intern0 ("out-of-range")));
f5bf2977 GH	334	scm_arg_type_key
	335	= scm_permanent_object (SCM_CAR (scm_intern0 ("wrong-type-arg")));
	336	scm_args_number_key
	337	= scm_permanent_object (SCM_CAR (scm_intern0 ("wrong-number-of-args")));
	338	scm_memory_alloc_key
	339	= scm_permanent_object (SCM_CAR (scm_intern0 ("memory-allocation-error")));
	340	scm_stack_overflow_key
	341	= scm_permanent_object (SCM_CAR (scm_intern0 ("stack-overflow")));
	342	scm_misc_error_key
	343	= scm_permanent_object (SCM_CAR (scm_intern0 ("misc-error")));
0f2d19dd JB	344	#include "error.x"
	345	}
	346