1 /* Printing of backtraces and error messages
2 * Copyright (C) 1996, 1997, 1998, 1999 Free Software Foundation
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2, or (at your option)
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this software; see the file COPYING. If not, write to
16 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17 * Boston, MA 02111-1307 USA
19 * As a special exception, the Free Software Foundation gives permission
20 * for additional uses of the text contained in its release of GUILE.
22 * The exception is that, if you link the GUILE library with other files
23 * to produce an executable, this does not by itself cause the
24 * resulting executable to be covered by the GNU General Public License.
25 * Your use of that executable is in no way restricted on account of
26 * linking the GUILE library code into it.
28 * This exception does not however invalidate any other reasons why
29 * the executable file might be covered by the GNU General Public License.
31 * This exception applies only to the code released by the
32 * Free Software Foundation under the name GUILE. If you copy
33 * code from other Free Software Foundation releases into a copy of
34 * GUILE, as the General Public License permits, the exception does
35 * not apply to the code that you add in this way. To avoid misleading
36 * anyone as to the status of such modified files, you must delete
37 * this exception notice from them.
39 * If you write modifications of your own for GUILE, it is your choice
40 * whether to permit this exception to apply to your modifications.
41 * If you do not wish that, delete this exception notice.
43 * The author can be reached at djurfeldt@nada.kth.se
44 * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
46 /* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
47 gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
53 #include "libguile/_scm.h"
59 #include "libguile/stacks.h"
60 #include "libguile/srcprop.h"
61 #include "libguile/struct.h"
62 #include "libguile/strports.h"
63 #include "libguile/throw.h"
64 #include "libguile/fluids.h"
65 #include "libguile/ports.h"
66 #include "libguile/strings.h"
68 #include "libguile/validate.h"
69 #include "libguile/backtrace.h"
71 /* {Error reporting and backtraces}
72 * (A first approximation.)
74 * Note that these functions shouldn't generate errors themselves.
79 #define SCM_ASSERT(_cond, _arg, _pos, _subr) \
84 SCM scm_the_last_stack_fluid
;
87 display_header (SCM source
, SCM port
)
89 SCM fname
= (SCM_MEMOIZEDP (source
)
90 ? scm_source_property (source
, scm_sym_filename
)
92 if (SCM_STRINGP (fname
))
94 scm_prin1 (fname
, port
, 0);
96 scm_intprint (SCM_INUM (scm_source_property (source
, scm_sym_line
)) + 1,
100 scm_intprint (SCM_INUM (scm_source_property (source
, scm_sym_column
)) + 1,
105 scm_puts ("ERROR", port
);
106 scm_puts (": ", port
);
111 scm_display_error_message (SCM message
, SCM args
, SCM port
)
113 if (SCM_ROSTRINGP (message
) && SCM_NFALSEP (scm_list_p (args
)))
115 scm_simple_format (port
, message
, args
);
120 scm_prin1 (message
, port
, 0);
121 scm_putc ('\n', port
);
126 display_expression (SCM frame
,SCM pname
,SCM source
,SCM port
)
128 SCM print_state
= scm_make_print_state ();
129 scm_print_state
*pstate
= SCM_PRINT_STATE (print_state
);
130 pstate
->writingp
= 0;
134 if (SCM_ROSTRINGP (pname
))
136 if (SCM_FRAMEP (frame
)
137 && SCM_FRAME_EVAL_ARGS_P (frame
))
138 scm_puts ("While evaluating arguments to ", port
);
140 scm_puts ("In procedure ", port
);
141 scm_iprin1 (pname
, port
, pstate
);
142 if (SCM_MEMOIZEDP (source
))
144 scm_puts (" in expression ", port
);
145 pstate
->writingp
= 1;
146 scm_iprin1 (scm_unmemoize (source
), port
, pstate
);
149 else if (SCM_NIMP (source
))
151 scm_puts ("In expression ", port
);
152 pstate
->writingp
= 1;
153 scm_iprin1 (scm_unmemoize (source
), port
, pstate
);
155 scm_puts (":\n", port
);
156 scm_free_print_state (print_state
);
159 struct display_error_args
{
169 display_error_body (struct display_error_args
*a
)
171 SCM current_frame
= SCM_BOOL_F
;
172 SCM source
= SCM_BOOL_F
;
173 SCM pname
= SCM_BOOL_F
;
174 SCM prev_frame
= SCM_BOOL_F
;
177 && SCM_STACKP (a
->stack
)
178 && SCM_STACK_LENGTH (a
->stack
) > 0)
180 current_frame
= scm_stack_ref (a
->stack
, SCM_INUM0
);
181 source
= SCM_FRAME_SOURCE (current_frame
);
182 prev_frame
= SCM_FRAME_PREV (current_frame
);
183 if (!SCM_MEMOIZEDP (source
) && !SCM_FALSEP (prev_frame
))
184 source
= SCM_FRAME_SOURCE (prev_frame
);
185 if (SCM_FRAME_PROC_P (current_frame
)
186 && SCM_TRUE_P (scm_procedure_p (SCM_FRAME_PROC (current_frame
))))
187 pname
= scm_procedure_name (SCM_FRAME_PROC (current_frame
));
189 if (!SCM_ROSTRINGP (pname
))
191 if (SCM_ROSTRINGP (pname
) || SCM_MEMOIZEDP (source
))
193 display_header (source
, a
->port
);
194 display_expression (current_frame
, pname
, source
, a
->port
);
196 display_header (source
, a
->port
);
197 scm_display_error_message (a
->message
, a
->args
, a
->port
);
198 return SCM_UNSPECIFIED
;
201 struct display_error_handler_data
{
206 /* This is the exception handler for error reporting routines.
207 Note that it is very important that this handler *doesn't* try to
208 print more than the error tag, since the error very probably is
209 caused by an erroneous print call-back routine. If we would
210 try to print all objects, we would enter an infinite loop. */
212 display_error_handler (struct display_error_handler_data
*data
,
215 SCM print_state
= scm_make_print_state ();
216 scm_puts ("\nException during displaying of ", data
->port
);
217 scm_puts (data
->mode
, data
->port
);
218 scm_puts (": ", data
->port
);
219 scm_iprin1 (tag
, data
->port
, SCM_PRINT_STATE (print_state
));
220 scm_putc ('\n', data
->port
);
221 return SCM_UNSPECIFIED
;
224 SCM_DEFINE (scm_display_error
, "display-error", 6, 0, 0,
225 (SCM stack
, SCM port
, SCM subr
, SCM message
, SCM args
, SCM rest
),
227 #define FUNC_NAME s_scm_display_error
229 struct display_error_args a
;
230 struct display_error_handler_data data
;
239 scm_internal_catch (SCM_BOOL_T
,
240 (scm_catch_body_t
) display_error_body
, &a
,
241 (scm_catch_handler_t
) display_error_handler
, &data
);
242 return SCM_UNSPECIFIED
;
251 static int n_print_params
= 9;
252 static print_params_t default_print_params
[] = {
256 { 1, 4 }, { 1, 3 }, { 1, 2 }
258 static print_params_t
*print_params
= default_print_params
;
261 SCM_DEFINE (scm_set_print_params_x
, "set-print-params!", 1, 0, 0,
264 #define FUNC_NAME s_scm_set_print_params_x
269 print_params_t
*new_params
;
271 SCM_VALIDATE_NONEMPTYLIST_COPYLEN (2, params
, n
);
272 for (ls
= params
; SCM_NNULLP (ls
); ls
= SCM_CDR (ls
))
273 SCM_ASSERT (scm_ilength (SCM_CAR (params
)) == 2
274 && SCM_INUMP (SCM_CAAR (ls
))
275 && SCM_INUM (SCM_CAAR (ls
)) >= 0
276 && SCM_INUMP (SCM_CADAR (ls
))
277 && SCM_INUM (SCM_CADAR (ls
)) >= 0,
280 s_scm_set_print_params_x
);
281 new_params
= scm_must_malloc (n
* sizeof (print_params_t
),
283 if (print_params
!= default_print_params
)
284 scm_must_free (print_params
);
285 print_params
= new_params
;
286 for (i
= 0; i
< n
; ++i
)
288 print_params
[i
].level
= SCM_INUM (SCM_CAAR (params
));
289 print_params
[i
].length
= SCM_INUM (SCM_CADAR (params
));
290 params
= SCM_CDR (params
);
293 return SCM_UNSPECIFIED
;
299 indent (int n
, SCM port
)
302 for (i
= 0; i
< n
; ++i
)
303 scm_putc (' ', port
);
307 display_frame_expr (char *hdr
,SCM exp
,char *tlr
,int indentation
,SCM sport
,SCM port
,scm_print_state
*pstate
)
311 scm_ptob_descriptor
*ptob
= scm_ptobs
+ SCM_PTOBNUM (sport
);
314 pstate
->length
= print_params
[i
].length
;
315 ptob
->seek (sport
, 0, SEEK_SET
);
318 pstate
->level
= print_params
[i
].level
- 1;
319 scm_iprlist (hdr
, exp
, tlr
[0], sport
, pstate
);
320 scm_puts (&tlr
[1], sport
);
324 pstate
->level
= print_params
[i
].level
;
325 scm_iprin1 (exp
, sport
, pstate
);
328 n
= ptob
->seek (sport
, 0, SEEK_CUR
);
331 while (indentation
+ n
> SCM_BACKTRACE_WIDTH
&& i
< n_print_params
);
332 ptob
->truncate (sport
, n
);
333 string
= scm_strport_to_string (sport
);
334 /* Remove control characters */
335 for (i
= 0; i
< n
; ++i
)
336 if (iscntrl (SCM_CHARS (string
)[i
]))
337 SCM_CHARS (string
)[i
] = ' ';
339 if (indentation
+ n
> SCM_BACKTRACE_WIDTH
)
341 n
= SCM_BACKTRACE_WIDTH
- indentation
;
342 SCM_CHARS (string
)[n
- 1] = '$';
345 scm_lfwrite (SCM_CHARS (string
), n
, port
);
349 display_application (SCM frame
,int indentation
,SCM sport
,SCM port
,scm_print_state
*pstate
)
351 SCM proc
= SCM_FRAME_PROC (frame
);
352 SCM name
= (SCM_NFALSEP (scm_procedure_p (proc
))
353 ? scm_procedure_name (proc
)
355 display_frame_expr ("[",
356 scm_cons (SCM_NFALSEP (name
) ? name
: proc
,
357 SCM_FRAME_ARGS (frame
)),
358 SCM_FRAME_EVAL_ARGS_P (frame
) ? " ..." : "]",
365 SCM_DEFINE (scm_display_application
, "display-application", 1, 2, 0,
366 (SCM frame
, SCM port
, SCM indent
),
368 #define FUNC_NAME s_scm_display_application
370 SCM_VALIDATE_FRAME (1,frame
);
371 if (SCM_UNBNDP (port
))
374 SCM_VALIDATE_OPOUTPORT (2,port
);
375 if (SCM_UNBNDP (indent
))
378 SCM_VALIDATE_INUM (3,indent
);
380 if (SCM_FRAME_PROC_P (frame
))
381 /* Display an application. */
383 SCM sport
, print_state
;
384 scm_print_state
*pstate
;
386 /* Create a string port used for adaptation of printing parameters. */
387 sport
= scm_mkstrport (SCM_INUM0
,
388 scm_make_string (SCM_MAKINUM (240),
393 /* Create a print state for printing of frames. */
394 print_state
= scm_make_print_state ();
395 pstate
= SCM_PRINT_STATE (print_state
);
396 pstate
->writingp
= 1;
399 display_application (frame
, SCM_INUM (indent
), sport
, port
, pstate
);
408 display_frame (SCM frame
,int nfield
,int indentation
,SCM sport
,SCM port
,scm_print_state
*pstate
)
412 /* Announce missing frames? */
413 if (!SCM_BACKWARDS_P
&& SCM_FRAME_OVERFLOW_P (frame
))
415 indent (nfield
+ 1 + indentation
, port
);
416 scm_puts ("...\n", port
);
419 /* Check size of frame number. */
420 n
= SCM_FRAME_NUMBER (frame
);
421 for (i
= 0, j
= n
; j
> 0; ++i
) j
/= 10;
423 /* Number indentation. */
424 indent (nfield
- (i
? i
: 1), port
);
427 scm_iprin1 (SCM_MAKINUM (n
), port
, pstate
);
429 /* Real frame marker */
430 scm_putc (SCM_FRAME_REAL_P (frame
) ? '*' : ' ', port
);
433 indent (indentation
, port
);
435 if (SCM_FRAME_PROC_P (frame
))
436 /* Display an application. */
437 display_application (frame
, nfield
+ 1 + indentation
, sport
, port
, pstate
);
439 /* Display a special form. */
441 SCM source
= SCM_FRAME_SOURCE (frame
);
442 SCM copy
= (SCM_CONSP (source
)
443 ? scm_source_property (source
, scm_sym_copy
)
445 SCM umcopy
= (SCM_MEMOIZEDP (source
)
446 ? scm_unmemoize (source
)
448 display_frame_expr ("(",
449 SCM_CONSP (copy
) ? copy
: umcopy
,
451 nfield
+ 1 + indentation
,
456 scm_putc ('\n', port
);
458 /* Announce missing frames? */
459 if (SCM_BACKWARDS_P
&& SCM_FRAME_OVERFLOW_P (frame
))
461 indent (nfield
+ 1 + indentation
, port
);
462 scm_puts ("...\n", port
);
466 struct display_backtrace_args
{
474 display_backtrace_body(struct display_backtrace_args
*a
)
475 #define FUNC_NAME "display_backtrace_body"
477 int n_frames
, beg
, end
, n
, i
, j
;
478 int nfield
, indent_p
, indentation
;
479 SCM frame
, sport
, print_state
;
480 scm_print_state
*pstate
;
482 a
->port
= SCM_COERCE_OUTPORT (a
->port
);
484 /* Argument checking and extraction. */
485 SCM_ASSERT (SCM_STACKP (a
->stack
),
488 s_display_backtrace
);
489 SCM_ASSERT (SCM_OPOUTPORTP (a
->port
),
492 s_display_backtrace
);
493 n_frames
= SCM_INUM (scm_stack_length (a
->stack
));
494 n
= SCM_INUMP (a
->depth
) ? SCM_INUM (a
->depth
) : SCM_BACKTRACE_DEPTH
;
497 beg
= SCM_INUMP (a
->first
) ? SCM_INUM (a
->first
) : 0;
505 if (SCM_INUMP (a
->first
))
507 beg
= SCM_INUM (a
->first
);
521 SCM_ASSERT (beg
>= 0 && beg
< n_frames
, a
->first
, SCM_ARG3
, s_display_backtrace
);
522 SCM_ASSERT (n
> 0, a
->depth
, SCM_ARG4
, s_display_backtrace
);
524 /* Create a string port used for adaptation of printing parameters. */
525 sport
= scm_mkstrport (SCM_INUM0
,
526 scm_make_string (SCM_MAKINUM (240), SCM_UNDEFINED
),
530 /* Create a print state for printing of frames. */
531 print_state
= scm_make_print_state ();
532 pstate
= SCM_PRINT_STATE (print_state
);
533 pstate
->writingp
= 1;
536 /* First find out if it's reasonable to do indentation. */
542 frame
= scm_stack_ref (a
->stack
, SCM_MAKINUM (beg
));
543 for (i
= 0, j
= 0; i
< n
; ++i
)
545 if (SCM_FRAME_REAL_P (frame
))
547 if (j
> SCM_BACKTRACE_INDENT
)
552 frame
= (SCM_BACKWARDS_P
553 ? SCM_FRAME_PREV (frame
)
554 : SCM_FRAME_NEXT (frame
));
558 /* Determine size of frame number field. */
559 j
= SCM_FRAME_NUMBER (scm_stack_ref (a
->stack
, SCM_MAKINUM (end
)));
560 for (i
= 0; j
> 0; ++i
) j
/= 10;
564 frame
= scm_stack_ref (a
->stack
, SCM_MAKINUM (beg
));
566 display_frame (frame
, nfield
, indentation
, sport
, a
->port
, pstate
);
567 for (i
= 1; i
< n
; ++i
)
569 if (indent_p
&& SCM_FRAME_EVAL_ARGS_P (frame
))
571 frame
= SCM_BACKWARDS_P
? SCM_FRAME_PREV (frame
) : SCM_FRAME_NEXT (frame
);
572 display_frame (frame
, nfield
, indentation
, sport
, a
->port
, pstate
);
575 return SCM_UNSPECIFIED
;
579 SCM_DEFINE (scm_display_backtrace
, "display-backtrace", 2, 2, 0,
580 (SCM stack
, SCM port
, SCM first
, SCM depth
),
582 #define FUNC_NAME s_scm_display_backtrace
584 struct display_backtrace_args a
;
585 struct display_error_handler_data data
;
590 data
.mode
= "backtrace";
592 scm_internal_catch (SCM_BOOL_T
,
593 (scm_catch_body_t
) display_backtrace_body
, &a
,
594 (scm_catch_handler_t
) display_error_handler
, &data
);
595 return SCM_UNSPECIFIED
;
599 SCM_VCELL (scm_has_shown_backtrace_hint_p_var
, "has-shown-backtrace-hint?");
601 SCM_DEFINE (scm_backtrace
, "backtrace", 0, 0, 0,
604 #define FUNC_NAME s_scm_backtrace
606 SCM the_last_stack
= scm_fluid_ref (SCM_CDR (scm_the_last_stack_fluid
));
607 if (SCM_NFALSEP (the_last_stack
))
609 scm_newline (scm_cur_outp
);
610 scm_puts ("Backtrace:\n", scm_cur_outp
);
611 scm_display_backtrace (the_last_stack
,
615 scm_newline (scm_cur_outp
);
616 if (SCM_FALSEP (SCM_CDR (scm_has_shown_backtrace_hint_p_var
))
619 scm_puts ("Type \"(debug-enable 'backtrace)\" if you would like "
621 "automatically if an error occurs in the future.\n",
623 SCM_SETCDR (scm_has_shown_backtrace_hint_p_var
, SCM_BOOL_T
);
628 scm_puts ("No backtrace available.\n", scm_cur_outp
);
630 return SCM_UNSPECIFIED
;
637 scm_init_backtrace ()
639 SCM f
= scm_make_fluid ();
640 scm_the_last_stack_fluid
= scm_sysintern ("the-last-stack", f
);
642 #include "libguile/backtrace.x"