Make (ice-9 buffered-input) more general
[bpt/guile.git] / libguile / error.c
CommitLineData
ef18914a 1/* Copyright (C) 1995,1996,1997,1998, 2000 Free Software Foundation, Inc.
0f2d19dd
JB
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
82892bed
JB
15 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
16 * Boston, MA 02111-1307 USA
0f2d19dd
JB
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.
82892bed 40 * If you do not wish that, delete this exception notice. */
1bbd0b84
GB
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
0f2d19dd
JB
45\f
46
47#include <stdio.h>
bd9e24b3 48
a0599745
MD
49#include "libguile/_scm.h"
50#include "libguile/pairs.h"
51#include "libguile/strings.h"
52#include "libguile/throw.h"
20e6290e 53
a0599745
MD
54#include "libguile/validate.h"
55#include "libguile/error.h"
0f2d19dd 56
bd9e24b3
GH
57#ifdef HAVE_STRING_H
58#include <string.h>
59#endif
95b88819
GH
60#ifdef HAVE_UNISTD_H
61#include <unistd.h>
62#endif
0f2d19dd
JB
63\f
64
65\f
66/* {Errors and Exceptional Conditions}
67 */
68
0f2d19dd 69
0f2d19dd 70extern int errno;
f5bf2977 71
c37e0e55 72/* All errors should pass through here. */
7cb1d4d3 73void
1bbd0b84 74scm_error (SCM key, const char *subr, const char *message, SCM args, SCM rest)
7cb1d4d3
GH
75{
76 SCM arg_list;
406c7d90 77 if (scm_gc_running_p)
ef18914a
MD
78 {
79 /* The error occured during GC --- abort */
80 fprintf (stderr, "Error in %s during GC: %s\n",
81 subr ? subr : "unknown function",
82 message ? message : "<empty message>");
83 abort ();
84 }
f5bf2977 85 arg_list = scm_listify (subr ? scm_makfrom0str (subr) : SCM_BOOL_F,
b59b97ba 86 message ? scm_makfrom0str (message) : SCM_BOOL_F,
7cb1d4d3
GH
87 args,
88 rest,
89 SCM_UNDEFINED);
90 scm_ithrow (key, arg_list, 1);
91
92 /* No return, but just in case: */
5c11cc9d
GH
93 {
94 const char msg[] = "guile:scm_error:scm_ithrow returned!\n";
7cb1d4d3 95
5c11cc9d
GH
96 write (2, msg, (sizeof msg) - 1);
97 }
7cb1d4d3
GH
98 exit (1);
99}
0f2d19dd 100
c37e0e55 101/* Scheme interface to scm_error. */
3b3b36dd 102SCM_DEFINE (scm_error_scm, "scm-error", 5, 0, 0,
1bbd0b84 103 (SCM key, SCM subr, SCM message, SCM args, SCM rest),
b380b885
MD
104 "Raise an error with key @var{key}. @var{subr} can be a string naming\n"
105 "the procedure associated with the error, or @code{#f}. @var{message}\n"
106 "is the error message string, possibly containing @code{~S} and @code{~A}\n"
107 "escapes. When an error is reported, these are replaced by formating the\n"
108 "corresponding members of @var{args}: @code{~A} (was @code{%s}) formats using @code{display}\n"
872e0c72 109 "and @code{~S} (was @code{%S}) formats using @code{write}. @var{data} is a\n"
b380b885
MD
110 "list or @code{#f} depending on @var{key}: if @var{key} is\n"
111 "@code{system-error} then it should be a list\n"
112 "containing the Unix @code{errno} value; If @var{key} is @code{signal} then\n"
113 "it should be a list containing the Unix signal number; otherwise it\n"
114 "will usually be @code{#f}.")
1bbd0b84 115#define FUNC_NAME s_scm_error_scm
c37e0e55 116{
1bbd0b84
GB
117 char *szSubr;
118 char *szMessage;
a6d9e5ab
DH
119
120 SCM_VALIDATE_SYMBOL (1, key);
121
122 if (SCM_FALSEP (subr))
123 {
124 szSubr = NULL;
125 }
126 else if (SCM_SYMBOLP (subr))
127 {
128 szSubr = SCM_SYMBOL_CHARS (subr);
129 }
130 else
131 {
132 SCM_VALIDATE_STRING (2, subr);
133 SCM_STRING_COERCE_0TERMINATION_X (subr);
134 szSubr = SCM_STRING_CHARS (subr);
135 }
136
137 if (SCM_FALSEP (message))
138 {
139 szMessage = NULL;
140 }
141 else
142 {
143 SCM_VALIDATE_STRING (2, message);
144 SCM_STRING_COERCE_0TERMINATION_X (message);
145 szMessage = SCM_STRING_CHARS (message);
146 }
89958ad0 147
1bbd0b84 148 scm_error (key, szSubr, szMessage, args, rest);
c37e0e55
GH
149 /* not reached. */
150}
1bbd0b84 151#undef FUNC_NAME
c37e0e55 152
a1ec6916 153SCM_DEFINE (scm_strerror, "strerror", 1, 0, 0,
1bbd0b84 154 (SCM err),
1de052a7 155 "Returns the Unix error message corresponding to @var{err}, an integer.")
1bbd0b84 156#define FUNC_NAME s_scm_strerror
efb997f5 157{
3b3b36dd 158 SCM_VALIDATE_INUM (1,err);
efb997f5
GH
159 return scm_makfrom0str (strerror (SCM_INUM (err)));
160}
1bbd0b84 161#undef FUNC_NAME
efb997f5 162
523f5266 163SCM_SYMBOL (scm_system_error_key, "system-error");
52859adf 164void
1bbd0b84 165scm_syserror (const char *subr)
52859adf 166{
1de052a7
GH
167 int save_errno = errno;
168
01f61221 169 scm_error (scm_system_error_key,
52859adf 170 subr,
70d63753 171 "~A",
1de052a7
GH
172 scm_cons (scm_makfrom0str (strerror (save_errno)), SCM_EOL),
173 scm_cons (SCM_MAKINUM (save_errno), SCM_EOL));
52859adf
GH
174}
175
176void
1bbd0b84 177scm_syserror_msg (const char *subr, const char *message, SCM args, int eno)
52859adf 178{
01f61221 179 scm_error (scm_system_error_key,
52859adf
GH
180 subr,
181 message,
182 args,
5c11cc9d 183 scm_cons (SCM_MAKINUM (eno), SCM_EOL));
52859adf
GH
184}
185
f5f2dcff
DH
186
187#if (SCM_DEBUG_DEPRECATED == 0)
188
f25f761d
GH
189/* scm_sysmissing is no longer used in libguile. it can probably be
190 removed after a release or two. there's a comment in NEWS about it
191 (2000-01-09). */
52859adf 192void
1bbd0b84 193scm_sysmissing (const char *subr)
52859adf
GH
194{
195#ifdef ENOSYS
01f61221 196 scm_error (scm_system_error_key,
52859adf 197 subr,
70d63753 198 "~A",
5c11cc9d
GH
199 scm_cons (scm_makfrom0str (strerror (ENOSYS)), SCM_EOL),
200 scm_cons (SCM_MAKINUM (ENOSYS), SCM_EOL));
52859adf 201#else
01f61221 202 scm_error (scm_system_error_key,
52859adf
GH
203 subr,
204 "Missing function",
205 SCM_BOOL_F,
5c11cc9d 206 scm_cons (SCM_MAKINUM (0), SCM_EOL));
52859adf
GH
207#endif
208}
209
f5f2dcff
DH
210#endif /* SCM_DEBUG_DEPRECATED == 0 */
211
212
523f5266 213SCM_SYMBOL (scm_num_overflow_key, "numerical-overflow");
52859adf 214void
1bbd0b84 215scm_num_overflow (const char *subr)
52859adf 216{
01f61221 217 scm_error (scm_num_overflow_key,
52859adf
GH
218 subr,
219 "Numerical overflow",
220 SCM_BOOL_F,
221 SCM_BOOL_F);
222}
223
523f5266 224SCM_SYMBOL (scm_out_of_range_key, "out-of-range");
52859adf 225void
1bbd0b84 226scm_out_of_range (const char *subr, SCM bad_value)
52859adf 227{
01f61221 228 scm_error (scm_out_of_range_key,
52859adf 229 subr,
70d63753 230 "Argument out of range: ~S",
b6791b2e 231 SCM_LIST1(bad_value),
52859adf
GH
232 SCM_BOOL_F);
233}
f5bf2977 234
1e76143f
GB
235void
236scm_out_of_range_pos (const char *subr, SCM bad_value, SCM pos)
237{
238 scm_error (scm_out_of_range_key,
239 subr,
70d63753 240 "Argument ~S out of range: ~S",
b6791b2e 241 SCM_LIST2(pos,bad_value),
1e76143f
GB
242 SCM_BOOL_F);
243}
244
245
523f5266 246SCM_SYMBOL (scm_args_number_key, "wrong-number-of-args");
0f2d19dd 247void
1bbd0b84 248scm_wrong_num_args (SCM proc)
f5bf2977 249{
01f61221 250 scm_error (scm_args_number_key,
f5bf2977 251 NULL,
70d63753 252 "Wrong number of arguments to ~A",
b6791b2e 253 SCM_LIST1(proc),
f5bf2977
GH
254 SCM_BOOL_F);
255}
256
523f5266 257SCM_SYMBOL (scm_arg_type_key, "wrong-type-arg");
f5bf2977 258void
1bbd0b84 259scm_wrong_type_arg (const char *subr, int pos, SCM bad_value)
f5bf2977 260{
01f61221 261 scm_error (scm_arg_type_key,
f5bf2977 262 subr,
70d63753
GB
263 (pos == 0) ? "Wrong type argument: ~S"
264 : "Wrong type argument in position ~A: ~S",
b6791b2e
GB
265 (pos == 0) ? SCM_LIST1(bad_value)
266 : SCM_LIST2(SCM_MAKINUM(pos), bad_value),
f5bf2977
GH
267 SCM_BOOL_F);
268}
269
b6791b2e
GB
270void
271scm_wrong_type_arg_msg (const char *subr, int pos, SCM bad_value, const char *szMessage)
272{
273 SCM msg = scm_makfrom0str(szMessage);
274 if (pos == 0) {
275 scm_error (scm_arg_type_key,
276 subr, "Wrong type argument (expecting ~A): ~S",
277 SCM_LIST2(msg,bad_value),
278 SCM_BOOL_F);
279 } else {
280 scm_error (scm_arg_type_key,
281 subr,
282 "Wrong type argument in position ~A (expecting ~A): ~S",
283 SCM_LIST3(SCM_MAKINUM(pos),msg,bad_value),
284 SCM_BOOL_F);
285 }
286}
287
288
523f5266 289SCM_SYMBOL (scm_memory_alloc_key, "memory-allocation-error");
f5bf2977 290void
1bbd0b84 291scm_memory_error (const char *subr)
f5bf2977 292{
01f61221 293 scm_error (scm_memory_alloc_key,
f5bf2977
GH
294 subr,
295 "Memory allocation error",
296 SCM_BOOL_F,
297 SCM_BOOL_F);
298}
299
523f5266
GH
300SCM_SYMBOL (scm_misc_error_key, "misc-error");
301void
1bbd0b84 302scm_misc_error (const char *subr, const char *message, SCM args)
523f5266
GH
303{
304 scm_error (scm_misc_error_key, subr, message, args, SCM_BOOL_F);
305}
306
f5bf2977
GH
307/* implements the SCM_ASSERT interface. */
308SCM
1bbd0b84 309scm_wta (SCM arg, const char *pos, const char *s_subr)
f5bf2977
GH
310{
311 if (!s_subr || !*s_subr)
312 s_subr = NULL;
313 if ((~0x1fL) & (long) pos)
314 {
315 /* error string supplied. */
26a4f923 316 scm_misc_error (s_subr, pos, SCM_LIST1 (arg));
f5bf2977
GH
317 }
318 else
319 {
320 /* numerical error code. */
321 int error = (long) pos;
322
323 switch (error)
324 {
325 case SCM_ARGn:
326 scm_wrong_type_arg (s_subr, 0, arg);
327 case SCM_ARG1:
328 scm_wrong_type_arg (s_subr, 1, arg);
329 case SCM_ARG2:
330 scm_wrong_type_arg (s_subr, 2, arg);
331 case SCM_ARG3:
332 scm_wrong_type_arg (s_subr, 3, arg);
333 case SCM_ARG4:
334 scm_wrong_type_arg (s_subr, 4, arg);
335 case SCM_ARG5:
336 scm_wrong_type_arg (s_subr, 5, arg);
3d9352fb
MD
337 case SCM_ARG6:
338 scm_wrong_type_arg (s_subr, 6, arg);
339 case SCM_ARG7:
340 scm_wrong_type_arg (s_subr, 7, arg);
f5bf2977
GH
341 case SCM_WNA:
342 scm_wrong_num_args (arg);
b63a956d
DH
343
344#if (SCM_DEBUG_DEPRECATED == 0)
345
346 case SCM_OUTOFRANGE:
347 scm_out_of_range (s_subr, arg);
348 case SCM_NALLOC:
349 scm_memory_error (s_subr);
350
351#endif /* SCM_DEBUG_DEPRECATED == 0 */
352
f5bf2977
GH
353 default:
354 /* this shouldn't happen. */
b1edcd36 355 scm_misc_error (s_subr, "Unknown error", SCM_EOL);
f5bf2977
GH
356 }
357 }
358 return SCM_UNSPECIFIED;
359}
360
0f2d19dd
JB
361void
362scm_init_error ()
0f2d19dd 363{
a0599745 364#include "libguile/cpp_err_symbols.c"
8dc9439f 365#ifndef SCM_MAGIC_SNARFER
a0599745 366#include "libguile/error.x"
8dc9439f 367#endif
0f2d19dd
JB
368}
369
89e00824
ML
370
371/*
372 Local Variables:
373 c-file-style: "gnu"
374 End:
375*/