| 1 | /* Printing of backtraces and error messages |
| 2 | * Copyright (C) 1996,1997,1998,1999,2000,2001, 2003, 2004 Free Software Foundation |
| 3 | * |
| 4 | * This library is free software; you can redistribute it and/or |
| 5 | * modify it under the terms of the GNU Lesser General Public |
| 6 | * License as published by the Free Software Foundation; either |
| 7 | * version 2.1 of the License, or (at your option) any later version. |
| 8 | * |
| 9 | * This library 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 GNU |
| 12 | * Lesser General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU Lesser General Public |
| 15 | * License along with this library; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | */ |
| 18 | |
| 19 | #if HAVE_CONFIG_H |
| 20 | # include <config.h> |
| 21 | #endif |
| 22 | |
| 23 | #include <stdio.h> |
| 24 | #include <ctype.h> |
| 25 | #include <assert.h> |
| 26 | |
| 27 | #include "libguile/_scm.h" |
| 28 | |
| 29 | #ifdef HAVE_UNISTD_H |
| 30 | #include <unistd.h> |
| 31 | #endif |
| 32 | #ifdef HAVE_IO_H |
| 33 | #include <io.h> |
| 34 | #endif |
| 35 | |
| 36 | #include "libguile/stacks.h" |
| 37 | #include "libguile/srcprop.h" |
| 38 | #include "libguile/struct.h" |
| 39 | #include "libguile/strports.h" |
| 40 | #include "libguile/throw.h" |
| 41 | #include "libguile/fluids.h" |
| 42 | #include "libguile/ports.h" |
| 43 | #include "libguile/strings.h" |
| 44 | #include "libguile/dynwind.h" |
| 45 | |
| 46 | #include "libguile/validate.h" |
| 47 | #include "libguile/lang.h" |
| 48 | #include "libguile/backtrace.h" |
| 49 | #include "libguile/filesys.h" |
| 50 | |
| 51 | /* {Error reporting and backtraces} |
| 52 | * |
| 53 | * Note that these functions shouldn't generate errors themselves. |
| 54 | */ |
| 55 | |
| 56 | /* Print parameters for error messages. */ |
| 57 | |
| 58 | #define DISPLAY_ERROR_MESSAGE_MAX_LEVEL 7 |
| 59 | #define DISPLAY_ERROR_MESSAGE_MAX_LENGTH 10 |
| 60 | |
| 61 | /* Print parameters for failing expressions in error messages. |
| 62 | * (See also `print_params' below for backtrace print parameters.) |
| 63 | */ |
| 64 | |
| 65 | #define DISPLAY_EXPRESSION_MAX_LEVEL 2 |
| 66 | #define DISPLAY_EXPRESSION_MAX_LENGTH 3 |
| 67 | |
| 68 | #undef SCM_ASSERT |
| 69 | #define SCM_ASSERT(_cond, _arg, _pos, _subr) \ |
| 70 | if (!(_cond)) \ |
| 71 | return SCM_BOOL_F; |
| 72 | |
| 73 | SCM scm_the_last_stack_fluid_var; |
| 74 | |
| 75 | static void |
| 76 | display_header (SCM source, SCM port) |
| 77 | { |
| 78 | if (SCM_MEMOIZEDP (source)) |
| 79 | { |
| 80 | SCM fname = scm_source_property (source, scm_sym_filename); |
| 81 | SCM line = scm_source_property (source, scm_sym_line); |
| 82 | SCM col = scm_source_property (source, scm_sym_column); |
| 83 | |
| 84 | /* Dirk:FIXME:: Maybe we should store the _port_ rather than the |
| 85 | * filename with the source properties? Then we could in case of |
| 86 | * non-file ports give at least some more details than just |
| 87 | * "<unnamed port>". */ |
| 88 | if (scm_is_true (fname)) |
| 89 | scm_prin1 (fname, port, 0); |
| 90 | else |
| 91 | scm_puts ("<unnamed port>", port); |
| 92 | |
| 93 | if (scm_is_true (line) && scm_is_true (col)) |
| 94 | { |
| 95 | scm_putc (':', port); |
| 96 | scm_intprint (scm_to_long (line) + 1, 10, port); |
| 97 | scm_putc (':', port); |
| 98 | scm_intprint (scm_to_long (col) + 1, 10, port); |
| 99 | } |
| 100 | } |
| 101 | else |
| 102 | scm_puts ("ERROR", port); |
| 103 | scm_puts (": ", port); |
| 104 | } |
| 105 | |
| 106 | |
| 107 | struct display_error_message_data { |
| 108 | SCM message; |
| 109 | SCM args; |
| 110 | SCM port; |
| 111 | scm_print_state *pstate; |
| 112 | int old_fancyp; |
| 113 | int old_level; |
| 114 | int old_length; |
| 115 | }; |
| 116 | |
| 117 | static SCM |
| 118 | display_error_message (struct display_error_message_data *d) |
| 119 | { |
| 120 | if (scm_is_string (d->message) && scm_is_true (scm_list_p (d->args))) |
| 121 | scm_simple_format (d->port, d->message, d->args); |
| 122 | else |
| 123 | scm_display (d->message, d->port); |
| 124 | scm_newline (d->port); |
| 125 | return SCM_UNSPECIFIED; |
| 126 | } |
| 127 | |
| 128 | static void |
| 129 | before_display_error_message (struct display_error_message_data *d) |
| 130 | { |
| 131 | scm_print_state *pstate = d->pstate; |
| 132 | d->old_fancyp = pstate->fancyp; |
| 133 | d->old_level = pstate->level; |
| 134 | d->old_length = pstate->length; |
| 135 | pstate->fancyp = 1; |
| 136 | pstate->level = DISPLAY_ERROR_MESSAGE_MAX_LEVEL; |
| 137 | pstate->length = DISPLAY_ERROR_MESSAGE_MAX_LENGTH; |
| 138 | } |
| 139 | |
| 140 | static void |
| 141 | after_display_error_message (struct display_error_message_data *d) |
| 142 | { |
| 143 | scm_print_state *pstate = d->pstate; |
| 144 | pstate->fancyp = d->old_fancyp; |
| 145 | pstate->level = d->old_level; |
| 146 | pstate->length = d->old_length; |
| 147 | } |
| 148 | |
| 149 | void |
| 150 | scm_display_error_message (SCM message, SCM args, SCM port) |
| 151 | { |
| 152 | struct display_error_message_data d; |
| 153 | SCM print_state; |
| 154 | scm_print_state *pstate; |
| 155 | |
| 156 | port = scm_i_port_with_print_state (port, SCM_UNDEFINED); |
| 157 | print_state = SCM_PORT_WITH_PS_PS (port); |
| 158 | pstate = SCM_PRINT_STATE (print_state); |
| 159 | |
| 160 | d.message = message; |
| 161 | d.args = args; |
| 162 | d.port = port; |
| 163 | d.pstate = pstate; |
| 164 | scm_internal_dynamic_wind ((scm_t_guard) before_display_error_message, |
| 165 | (scm_t_inner) display_error_message, |
| 166 | (scm_t_guard) after_display_error_message, |
| 167 | &d, |
| 168 | &d); |
| 169 | } |
| 170 | |
| 171 | static void |
| 172 | display_expression (SCM frame, SCM pname, SCM source, SCM port) |
| 173 | { |
| 174 | SCM print_state = scm_make_print_state (); |
| 175 | scm_print_state *pstate = SCM_PRINT_STATE (print_state); |
| 176 | pstate->writingp = 0; |
| 177 | pstate->fancyp = 1; |
| 178 | pstate->level = DISPLAY_EXPRESSION_MAX_LEVEL; |
| 179 | pstate->length = DISPLAY_EXPRESSION_MAX_LENGTH; |
| 180 | if (scm_is_symbol (pname) || scm_is_string (pname)) |
| 181 | { |
| 182 | if (SCM_FRAMEP (frame) |
| 183 | && SCM_FRAME_EVAL_ARGS_P (frame)) |
| 184 | scm_puts ("While evaluating arguments to ", port); |
| 185 | else |
| 186 | scm_puts ("In procedure ", port); |
| 187 | scm_iprin1 (pname, port, pstate); |
| 188 | if (SCM_MEMOIZEDP (source)) |
| 189 | { |
| 190 | scm_puts (" in expression ", port); |
| 191 | pstate->writingp = 1; |
| 192 | scm_iprin1 (scm_i_unmemoize_expr (source), port, pstate); |
| 193 | } |
| 194 | } |
| 195 | else if (SCM_MEMOIZEDP (source)) |
| 196 | { |
| 197 | scm_puts ("In expression ", port); |
| 198 | pstate->writingp = 1; |
| 199 | scm_iprin1 (scm_i_unmemoize_expr (source), port, pstate); |
| 200 | } |
| 201 | scm_puts (":\n", port); |
| 202 | scm_free_print_state (print_state); |
| 203 | } |
| 204 | |
| 205 | struct display_error_args { |
| 206 | SCM stack; |
| 207 | SCM port; |
| 208 | SCM subr; |
| 209 | SCM message; |
| 210 | SCM args; |
| 211 | SCM rest; |
| 212 | }; |
| 213 | |
| 214 | static SCM |
| 215 | display_error_body (struct display_error_args *a) |
| 216 | { |
| 217 | SCM current_frame = SCM_BOOL_F; |
| 218 | SCM source = SCM_BOOL_F; |
| 219 | SCM prev_frame = SCM_BOOL_F; |
| 220 | SCM pname = a->subr; |
| 221 | |
| 222 | if (scm_debug_mode_p |
| 223 | && SCM_STACKP (a->stack) |
| 224 | && SCM_STACK_LENGTH (a->stack) > 0) |
| 225 | { |
| 226 | current_frame = scm_stack_ref (a->stack, SCM_INUM0); |
| 227 | source = SCM_FRAME_SOURCE (current_frame); |
| 228 | prev_frame = SCM_FRAME_PREV (current_frame); |
| 229 | if (!SCM_MEMOIZEDP (source) && scm_is_true (prev_frame)) |
| 230 | source = SCM_FRAME_SOURCE (prev_frame); |
| 231 | if (!scm_is_symbol (pname) |
| 232 | && !scm_is_string (pname) |
| 233 | && SCM_FRAME_PROC_P (current_frame) |
| 234 | && scm_is_true (scm_procedure_p (SCM_FRAME_PROC (current_frame)))) |
| 235 | pname = scm_procedure_name (SCM_FRAME_PROC (current_frame)); |
| 236 | } |
| 237 | if (scm_is_symbol (pname) || scm_is_string (pname) || SCM_MEMOIZEDP (source)) |
| 238 | { |
| 239 | display_header (source, a->port); |
| 240 | display_expression (current_frame, pname, source, a->port); |
| 241 | } |
| 242 | display_header (source, a->port); |
| 243 | scm_display_error_message (a->message, a->args, a->port); |
| 244 | return SCM_UNSPECIFIED; |
| 245 | } |
| 246 | |
| 247 | struct display_error_handler_data { |
| 248 | char *mode; |
| 249 | SCM port; |
| 250 | }; |
| 251 | |
| 252 | /* This is the exception handler for error reporting routines. |
| 253 | Note that it is very important that this handler *doesn't* try to |
| 254 | print more than the error tag, since the error very probably is |
| 255 | caused by an erroneous print call-back routine. If we would |
| 256 | try to print all objects, we would enter an infinite loop. */ |
| 257 | static SCM |
| 258 | display_error_handler (struct display_error_handler_data *data, |
| 259 | SCM tag, SCM args SCM_UNUSED) |
| 260 | { |
| 261 | SCM print_state = scm_make_print_state (); |
| 262 | scm_puts ("\nException during displaying of ", data->port); |
| 263 | scm_puts (data->mode, data->port); |
| 264 | scm_puts (": ", data->port); |
| 265 | scm_iprin1 (tag, data->port, SCM_PRINT_STATE (print_state)); |
| 266 | scm_putc ('\n', data->port); |
| 267 | return SCM_UNSPECIFIED; |
| 268 | } |
| 269 | |
| 270 | |
| 271 | /* The function scm_i_display_error prints out a detailed error message. This |
| 272 | * function will be called directly within libguile to signal error messages. |
| 273 | * No parameter checks will be performed by scm_i_display_error. Thus, User |
| 274 | * code should rather use the function scm_display_error. |
| 275 | */ |
| 276 | void |
| 277 | scm_i_display_error (SCM stack, SCM port, SCM subr, SCM message, SCM args, SCM rest) |
| 278 | { |
| 279 | struct display_error_args a; |
| 280 | struct display_error_handler_data data; |
| 281 | a.stack = stack; |
| 282 | a.port = port; |
| 283 | a.subr = subr; |
| 284 | a.message = message; |
| 285 | a.args = args; |
| 286 | a.rest = rest; |
| 287 | data.mode = "error"; |
| 288 | data.port = port; |
| 289 | scm_internal_catch (SCM_BOOL_T, |
| 290 | (scm_t_catch_body) display_error_body, &a, |
| 291 | (scm_t_catch_handler) display_error_handler, &data); |
| 292 | } |
| 293 | |
| 294 | |
| 295 | SCM_DEFINE (scm_display_error, "display-error", 6, 0, 0, |
| 296 | (SCM stack, SCM port, SCM subr, SCM message, SCM args, SCM rest), |
| 297 | "Display an error message to the output port @var{port}.\n" |
| 298 | "@var{stack} is the saved stack for the error, @var{subr} is\n" |
| 299 | "the name of the procedure in which the error occurred and\n" |
| 300 | "@var{message} is the actual error message, which may contain\n" |
| 301 | "formatting instructions. These will format the arguments in\n" |
| 302 | "the list @var{args} accordingly. @var{rest} is currently\n" |
| 303 | "ignored.") |
| 304 | #define FUNC_NAME s_scm_display_error |
| 305 | { |
| 306 | SCM_VALIDATE_OUTPUT_PORT (2, port); |
| 307 | |
| 308 | scm_i_display_error (stack, port, subr, message, args, rest); |
| 309 | |
| 310 | return SCM_UNSPECIFIED; |
| 311 | } |
| 312 | #undef FUNC_NAME |
| 313 | |
| 314 | |
| 315 | typedef struct { |
| 316 | int level; |
| 317 | int length; |
| 318 | } print_params_t; |
| 319 | |
| 320 | static int n_print_params = 9; |
| 321 | static print_params_t default_print_params[] = { |
| 322 | { 4, 9 }, { 4, 3 }, |
| 323 | { 3, 4 }, { 3, 3 }, |
| 324 | { 2, 4 }, { 2, 3 }, |
| 325 | { 1, 4 }, { 1, 3 }, { 1, 2 } |
| 326 | }; |
| 327 | static print_params_t *print_params = default_print_params; |
| 328 | |
| 329 | #ifdef GUILE_DEBUG |
| 330 | SCM_DEFINE (scm_set_print_params_x, "set-print-params!", 1, 0, 0, |
| 331 | (SCM params), |
| 332 | "Set the print parameters to the values from @var{params}.\n" |
| 333 | "@var{params} must be a list of two-element lists which must\n" |
| 334 | "hold two integer values.") |
| 335 | #define FUNC_NAME s_scm_set_print_params_x |
| 336 | { |
| 337 | int i; |
| 338 | int n; |
| 339 | SCM ls; |
| 340 | print_params_t *new_params; |
| 341 | |
| 342 | SCM_VALIDATE_NONEMPTYLIST_COPYLEN (2, params, n); |
| 343 | for (ls = params; !SCM_NULL_OR_NIL_P (ls); ls = SCM_CDR (ls)) |
| 344 | SCM_ASSERT (scm_ilength (SCM_CAR (params)) == 2 |
| 345 | && scm_is_unsigned_integer (SCM_CAAR (ls), 0, INT_MAX) |
| 346 | && scm_is_unsigned_integer (SCM_CADAR (ls), 0, INT_MAX), |
| 347 | params, |
| 348 | SCM_ARG2, |
| 349 | s_scm_set_print_params_x); |
| 350 | new_params = scm_malloc (n * sizeof (print_params_t)); |
| 351 | if (print_params != default_print_params) |
| 352 | free (print_params); |
| 353 | print_params = new_params; |
| 354 | for (i = 0; i < n; ++i) |
| 355 | { |
| 356 | print_params[i].level = scm_to_int (SCM_CAAR (params)); |
| 357 | print_params[i].length = scm_to_int (SCM_CADAR (params)); |
| 358 | params = SCM_CDR (params); |
| 359 | } |
| 360 | n_print_params = n; |
| 361 | return SCM_UNSPECIFIED; |
| 362 | } |
| 363 | #undef FUNC_NAME |
| 364 | #endif |
| 365 | |
| 366 | static void |
| 367 | indent (int n, SCM port) |
| 368 | { |
| 369 | int i; |
| 370 | for (i = 0; i < n; ++i) |
| 371 | scm_putc (' ', port); |
| 372 | } |
| 373 | |
| 374 | static void |
| 375 | display_frame_expr (char *hdr, SCM exp, char *tlr, int indentation, SCM sport, SCM port, scm_print_state *pstate) |
| 376 | { |
| 377 | SCM string; |
| 378 | int i = 0, n; |
| 379 | scm_t_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (sport); |
| 380 | do |
| 381 | { |
| 382 | pstate->length = print_params[i].length; |
| 383 | ptob->seek (sport, 0, SEEK_SET); |
| 384 | if (scm_is_pair (exp)) |
| 385 | { |
| 386 | pstate->level = print_params[i].level - 1; |
| 387 | scm_iprlist (hdr, exp, tlr[0], sport, pstate); |
| 388 | scm_puts (&tlr[1], sport); |
| 389 | } |
| 390 | else |
| 391 | { |
| 392 | pstate->level = print_params[i].level; |
| 393 | scm_iprin1 (exp, sport, pstate); |
| 394 | } |
| 395 | ptob->flush (sport); |
| 396 | n = ptob->seek (sport, 0, SEEK_CUR); |
| 397 | ++i; |
| 398 | } |
| 399 | while (indentation + n > SCM_BACKTRACE_WIDTH && i < n_print_params); |
| 400 | ptob->truncate (sport, n); |
| 401 | string = scm_strport_to_string (sport); |
| 402 | assert (scm_is_string (string)); |
| 403 | |
| 404 | { |
| 405 | char *data = scm_i_string_writable_chars (string); |
| 406 | |
| 407 | /* Remove control characters */ |
| 408 | for (i = 0; i < n; ++i) |
| 409 | if (iscntrl (data[i])) |
| 410 | data[i] = ' '; |
| 411 | /* Truncate */ |
| 412 | if (indentation + n > SCM_BACKTRACE_WIDTH) |
| 413 | { |
| 414 | n = SCM_BACKTRACE_WIDTH - indentation; |
| 415 | data[n-1] = '$'; |
| 416 | } |
| 417 | |
| 418 | scm_i_string_stop_writing (); |
| 419 | } |
| 420 | |
| 421 | scm_lfwrite (scm_i_string_chars (string), n, port); |
| 422 | scm_remember_upto_here_1 (string); |
| 423 | } |
| 424 | |
| 425 | static void |
| 426 | display_application (SCM frame, int indentation, SCM sport, SCM port, scm_print_state *pstate) |
| 427 | { |
| 428 | SCM proc = SCM_FRAME_PROC (frame); |
| 429 | SCM name = (scm_is_true (scm_procedure_p (proc)) |
| 430 | ? scm_procedure_name (proc) |
| 431 | : SCM_BOOL_F); |
| 432 | display_frame_expr ("[", |
| 433 | scm_cons (scm_is_true (name) ? name : proc, |
| 434 | SCM_FRAME_ARGS (frame)), |
| 435 | SCM_FRAME_EVAL_ARGS_P (frame) ? " ..." : "]", |
| 436 | indentation, |
| 437 | sport, |
| 438 | port, |
| 439 | pstate); |
| 440 | } |
| 441 | |
| 442 | SCM_DEFINE (scm_display_application, "display-application", 1, 2, 0, |
| 443 | (SCM frame, SCM port, SCM indent), |
| 444 | "Display a procedure application @var{frame} to the output port\n" |
| 445 | "@var{port}. @var{indent} specifies the indentation of the\n" |
| 446 | "output.") |
| 447 | #define FUNC_NAME s_scm_display_application |
| 448 | { |
| 449 | SCM_VALIDATE_FRAME (1, frame); |
| 450 | if (SCM_UNBNDP (port)) |
| 451 | port = scm_cur_outp; |
| 452 | else |
| 453 | SCM_VALIDATE_OPOUTPORT (2, port); |
| 454 | if (SCM_UNBNDP (indent)) |
| 455 | indent = SCM_INUM0; |
| 456 | |
| 457 | if (SCM_FRAME_PROC_P (frame)) |
| 458 | /* Display an application. */ |
| 459 | { |
| 460 | SCM sport, print_state; |
| 461 | scm_print_state *pstate; |
| 462 | |
| 463 | /* Create a string port used for adaptation of printing parameters. */ |
| 464 | sport = scm_mkstrport (SCM_INUM0, |
| 465 | scm_make_string (scm_from_int (240), |
| 466 | SCM_UNDEFINED), |
| 467 | SCM_OPN | SCM_WRTNG, |
| 468 | FUNC_NAME); |
| 469 | |
| 470 | /* Create a print state for printing of frames. */ |
| 471 | print_state = scm_make_print_state (); |
| 472 | pstate = SCM_PRINT_STATE (print_state); |
| 473 | pstate->writingp = 1; |
| 474 | pstate->fancyp = 1; |
| 475 | |
| 476 | display_application (frame, scm_to_int (indent), sport, port, pstate); |
| 477 | return SCM_BOOL_T; |
| 478 | } |
| 479 | else |
| 480 | return SCM_BOOL_F; |
| 481 | } |
| 482 | #undef FUNC_NAME |
| 483 | |
| 484 | SCM_SYMBOL (sym_base, "base"); |
| 485 | |
| 486 | static void |
| 487 | display_backtrace_get_file_line (SCM frame, SCM *file, SCM *line) |
| 488 | { |
| 489 | SCM source = SCM_FRAME_SOURCE (frame); |
| 490 | *file = SCM_MEMOIZEDP (source) ? scm_source_property (source, scm_sym_filename) : SCM_BOOL_F; |
| 491 | *line = (SCM_MEMOIZEDP (source)) ? scm_source_property (source, scm_sym_line) : SCM_BOOL_F; |
| 492 | } |
| 493 | |
| 494 | static void |
| 495 | display_backtrace_file (frame, last_file, port, pstate) |
| 496 | SCM frame; |
| 497 | SCM *last_file; |
| 498 | SCM port; |
| 499 | scm_print_state *pstate; |
| 500 | { |
| 501 | SCM file, line; |
| 502 | |
| 503 | display_backtrace_get_file_line (frame, &file, &line); |
| 504 | |
| 505 | if (scm_is_eq (file, *last_file)) |
| 506 | return; |
| 507 | |
| 508 | *last_file = file; |
| 509 | |
| 510 | scm_puts ("In ", port); |
| 511 | if (scm_is_false (file)) |
| 512 | if (scm_is_false (line)) |
| 513 | scm_puts ("unknown file", port); |
| 514 | else |
| 515 | scm_puts ("current input", port); |
| 516 | else |
| 517 | { |
| 518 | pstate->writingp = 0; |
| 519 | scm_iprin1 (file, port, pstate); |
| 520 | pstate->writingp = 1; |
| 521 | } |
| 522 | scm_puts (":\n", port); |
| 523 | } |
| 524 | |
| 525 | static void |
| 526 | display_backtrace_file_and_line (SCM frame, SCM port, scm_print_state *pstate) |
| 527 | { |
| 528 | SCM file, line; |
| 529 | |
| 530 | display_backtrace_get_file_line (frame, &file, &line); |
| 531 | |
| 532 | if (scm_is_eq (SCM_PACK (SCM_SHOW_FILE_NAME), sym_base)) |
| 533 | { |
| 534 | if (scm_is_false (file)) |
| 535 | { |
| 536 | if (scm_is_false (line)) |
| 537 | scm_putc ('?', port); |
| 538 | else |
| 539 | scm_puts ("<stdin>", port); |
| 540 | } |
| 541 | else |
| 542 | { |
| 543 | pstate -> writingp = 0; |
| 544 | #ifdef HAVE_POSIX |
| 545 | scm_iprin1 ((scm_is_string (file)? |
| 546 | scm_basename (file, SCM_UNDEFINED) : file), |
| 547 | port, pstate); |
| 548 | #else |
| 549 | scm_iprin1 (file, port, pstate); |
| 550 | #endif |
| 551 | pstate -> writingp = 1; |
| 552 | } |
| 553 | |
| 554 | scm_putc (':', port); |
| 555 | } |
| 556 | else if (scm_is_true (line)) |
| 557 | { |
| 558 | int i, j=0; |
| 559 | for (i = scm_to_int (line)+1; i > 0; i = i/10, j++) |
| 560 | ; |
| 561 | indent (4-j, port); |
| 562 | } |
| 563 | |
| 564 | if (scm_is_false (line)) |
| 565 | scm_puts (" ?", port); |
| 566 | else |
| 567 | scm_intprint (scm_to_int (line) + 1, 10, port); |
| 568 | scm_puts (": ", port); |
| 569 | } |
| 570 | |
| 571 | static void |
| 572 | display_frame (SCM frame, int nfield, int indentation, SCM sport, SCM port, scm_print_state *pstate) |
| 573 | { |
| 574 | int n, i, j; |
| 575 | |
| 576 | /* Announce missing frames? */ |
| 577 | if (!SCM_BACKWARDS_P && SCM_FRAME_OVERFLOW_P (frame)) |
| 578 | { |
| 579 | indent (nfield + 1 + indentation, port); |
| 580 | scm_puts ("...\n", port); |
| 581 | } |
| 582 | |
| 583 | /* display file name and line number */ |
| 584 | if (scm_is_true (SCM_PACK (SCM_SHOW_FILE_NAME))) |
| 585 | display_backtrace_file_and_line (frame, port, pstate); |
| 586 | |
| 587 | /* Check size of frame number. */ |
| 588 | n = SCM_FRAME_NUMBER (frame); |
| 589 | for (i = 0, j = n; j > 0; ++i) j /= 10; |
| 590 | |
| 591 | /* Number indentation. */ |
| 592 | indent (nfield - (i ? i : 1), port); |
| 593 | |
| 594 | /* Frame number. */ |
| 595 | scm_iprin1 (scm_from_int (n), port, pstate); |
| 596 | |
| 597 | /* Real frame marker */ |
| 598 | scm_putc (SCM_FRAME_REAL_P (frame) ? '*' : ' ', port); |
| 599 | |
| 600 | /* Indentation. */ |
| 601 | indent (indentation, port); |
| 602 | |
| 603 | if (SCM_FRAME_PROC_P (frame)) |
| 604 | /* Display an application. */ |
| 605 | display_application (frame, nfield + 1 + indentation, sport, port, pstate); |
| 606 | else |
| 607 | /* Display a special form. */ |
| 608 | { |
| 609 | SCM source = SCM_FRAME_SOURCE (frame); |
| 610 | SCM copy = (scm_is_pair (source) |
| 611 | ? scm_source_property (source, scm_sym_copy) |
| 612 | : SCM_BOOL_F); |
| 613 | SCM umcopy = (SCM_MEMOIZEDP (source) |
| 614 | ? scm_i_unmemoize_expr (source) |
| 615 | : SCM_BOOL_F); |
| 616 | display_frame_expr ("(", |
| 617 | scm_is_pair (copy) ? copy : umcopy, |
| 618 | ")", |
| 619 | nfield + 1 + indentation, |
| 620 | sport, |
| 621 | port, |
| 622 | pstate); |
| 623 | } |
| 624 | scm_putc ('\n', port); |
| 625 | |
| 626 | /* Announce missing frames? */ |
| 627 | if (SCM_BACKWARDS_P && SCM_FRAME_OVERFLOW_P (frame)) |
| 628 | { |
| 629 | indent (nfield + 1 + indentation, port); |
| 630 | scm_puts ("...\n", port); |
| 631 | } |
| 632 | } |
| 633 | |
| 634 | struct display_backtrace_args { |
| 635 | SCM stack; |
| 636 | SCM port; |
| 637 | SCM first; |
| 638 | SCM depth; |
| 639 | SCM highlight_objects; |
| 640 | }; |
| 641 | |
| 642 | static SCM |
| 643 | display_backtrace_body (struct display_backtrace_args *a) |
| 644 | #define FUNC_NAME "display_backtrace_body" |
| 645 | { |
| 646 | int n_frames, beg, end, n, i, j; |
| 647 | int nfield, indent_p, indentation; |
| 648 | SCM frame, sport, print_state; |
| 649 | SCM last_file; |
| 650 | scm_print_state *pstate; |
| 651 | |
| 652 | a->port = SCM_COERCE_OUTPORT (a->port); |
| 653 | |
| 654 | /* Argument checking and extraction. */ |
| 655 | SCM_VALIDATE_STACK (1, a->stack); |
| 656 | SCM_VALIDATE_OPOUTPORT (2, a->port); |
| 657 | n_frames = scm_to_int (scm_stack_length (a->stack)); |
| 658 | n = scm_is_integer (a->depth) ? scm_to_int (a->depth) : SCM_BACKTRACE_DEPTH; |
| 659 | if (SCM_BACKWARDS_P) |
| 660 | { |
| 661 | beg = scm_is_integer (a->first) ? scm_to_int (a->first) : 0; |
| 662 | end = beg + n - 1; |
| 663 | if (end >= n_frames) |
| 664 | end = n_frames - 1; |
| 665 | n = end - beg + 1; |
| 666 | } |
| 667 | else |
| 668 | { |
| 669 | if (scm_is_integer (a->first)) |
| 670 | { |
| 671 | beg = scm_to_int (a->first); |
| 672 | end = beg - n + 1; |
| 673 | if (end < 0) |
| 674 | end = 0; |
| 675 | } |
| 676 | else |
| 677 | { |
| 678 | beg = n - 1; |
| 679 | end = 0; |
| 680 | if (beg >= n_frames) |
| 681 | beg = n_frames - 1; |
| 682 | } |
| 683 | n = beg - end + 1; |
| 684 | } |
| 685 | SCM_ASSERT (beg >= 0 && beg < n_frames, a->first, SCM_ARG3, s_display_backtrace); |
| 686 | SCM_ASSERT (n > 0, a->depth, SCM_ARG4, s_display_backtrace); |
| 687 | |
| 688 | /* Create a string port used for adaptation of printing parameters. */ |
| 689 | sport = scm_mkstrport (SCM_INUM0, |
| 690 | scm_make_string (scm_from_int (240), SCM_UNDEFINED), |
| 691 | SCM_OPN | SCM_WRTNG, |
| 692 | FUNC_NAME); |
| 693 | |
| 694 | /* Create a print state for printing of frames. */ |
| 695 | print_state = scm_make_print_state (); |
| 696 | pstate = SCM_PRINT_STATE (print_state); |
| 697 | pstate->writingp = 1; |
| 698 | pstate->fancyp = 1; |
| 699 | pstate->highlight_objects = a->highlight_objects; |
| 700 | |
| 701 | /* First find out if it's reasonable to do indentation. */ |
| 702 | if (SCM_BACKWARDS_P) |
| 703 | indent_p = 0; |
| 704 | else |
| 705 | { |
| 706 | unsigned int j; |
| 707 | |
| 708 | indent_p = 1; |
| 709 | frame = scm_stack_ref (a->stack, scm_from_int (beg)); |
| 710 | for (i = 0, j = 0; i < n; ++i) |
| 711 | { |
| 712 | if (SCM_FRAME_REAL_P (frame)) |
| 713 | ++j; |
| 714 | if (j > SCM_BACKTRACE_INDENT) |
| 715 | { |
| 716 | indent_p = 0; |
| 717 | break; |
| 718 | } |
| 719 | frame = (SCM_BACKWARDS_P |
| 720 | ? SCM_FRAME_PREV (frame) |
| 721 | : SCM_FRAME_NEXT (frame)); |
| 722 | } |
| 723 | } |
| 724 | |
| 725 | /* Determine size of frame number field. */ |
| 726 | j = SCM_FRAME_NUMBER (scm_stack_ref (a->stack, scm_from_int (end))); |
| 727 | for (i = 0; j > 0; ++i) j /= 10; |
| 728 | nfield = i ? i : 1; |
| 729 | |
| 730 | /* Print frames. */ |
| 731 | frame = scm_stack_ref (a->stack, scm_from_int (beg)); |
| 732 | indentation = 1; |
| 733 | last_file = SCM_UNDEFINED; |
| 734 | for (i = 0; i < n; ++i) |
| 735 | { |
| 736 | if (!scm_is_eq (SCM_PACK (SCM_SHOW_FILE_NAME), sym_base)) |
| 737 | display_backtrace_file (frame, &last_file, a->port, pstate); |
| 738 | |
| 739 | display_frame (frame, nfield, indentation, sport, a->port, pstate); |
| 740 | if (indent_p && SCM_FRAME_EVAL_ARGS_P (frame)) |
| 741 | ++indentation; |
| 742 | frame = (SCM_BACKWARDS_P ? |
| 743 | SCM_FRAME_PREV (frame) : SCM_FRAME_NEXT (frame)); |
| 744 | } |
| 745 | |
| 746 | scm_remember_upto_here_1 (print_state); |
| 747 | |
| 748 | return SCM_UNSPECIFIED; |
| 749 | } |
| 750 | #undef FUNC_NAME |
| 751 | |
| 752 | SCM_DEFINE (scm_display_backtrace_with_highlights, "display-backtrace", |
| 753 | 2, 3, 0, |
| 754 | (SCM stack, SCM port, SCM first, SCM depth, SCM highlights), |
| 755 | "Display a backtrace to the output port @var{port}. @var{stack}\n" |
| 756 | "is the stack to take the backtrace from, @var{first} specifies\n" |
| 757 | "where in the stack to start and @var{depth} how much frames\n" |
| 758 | "to display. Both @var{first} and @var{depth} can be @code{#f},\n" |
| 759 | "which means that default values will be used.\n" |
| 760 | "When @var{highlights} is given,\n" |
| 761 | "it should be a list and all members of it are highligthed in\n" |
| 762 | "the backtrace.") |
| 763 | #define FUNC_NAME s_scm_display_backtrace_with_highlights |
| 764 | { |
| 765 | struct display_backtrace_args a; |
| 766 | struct display_error_handler_data data; |
| 767 | a.stack = stack; |
| 768 | a.port = port; |
| 769 | a.first = first; |
| 770 | a.depth = depth; |
| 771 | if (SCM_UNBNDP (highlights)) |
| 772 | a.highlight_objects = SCM_EOL; |
| 773 | else |
| 774 | a.highlight_objects = highlights; |
| 775 | data.mode = "backtrace"; |
| 776 | data.port = port; |
| 777 | scm_internal_catch (SCM_BOOL_T, |
| 778 | (scm_t_catch_body) display_backtrace_body, &a, |
| 779 | (scm_t_catch_handler) display_error_handler, &data); |
| 780 | return SCM_UNSPECIFIED; |
| 781 | } |
| 782 | #undef FUNC_NAME |
| 783 | |
| 784 | SCM |
| 785 | scm_display_backtrace (SCM stack, SCM port, SCM first, SCM depth) |
| 786 | { |
| 787 | return scm_display_backtrace_with_highlights (stack, port, first, depth, |
| 788 | SCM_EOL); |
| 789 | } |
| 790 | |
| 791 | SCM_VARIABLE (scm_has_shown_backtrace_hint_p_var, "has-shown-backtrace-hint?"); |
| 792 | |
| 793 | SCM_DEFINE (scm_backtrace_with_highlights, "backtrace", 0, 1, 0, |
| 794 | (SCM highlights), |
| 795 | "Display a backtrace of the stack saved by the last error\n" |
| 796 | "to the current output port. When @var{highlights} is given,\n" |
| 797 | "it should be a list and all members of it are highligthed in\n" |
| 798 | "the backtrace.") |
| 799 | #define FUNC_NAME s_scm_backtrace_with_highlights |
| 800 | { |
| 801 | SCM the_last_stack = |
| 802 | scm_fluid_ref (SCM_VARIABLE_REF (scm_the_last_stack_fluid_var)); |
| 803 | |
| 804 | if (SCM_UNBNDP (highlights)) |
| 805 | highlights = SCM_EOL; |
| 806 | |
| 807 | if (scm_is_true (the_last_stack)) |
| 808 | { |
| 809 | scm_newline (scm_cur_outp); |
| 810 | scm_puts ("Backtrace:\n", scm_cur_outp); |
| 811 | scm_display_backtrace_with_highlights (the_last_stack, |
| 812 | scm_cur_outp, |
| 813 | SCM_BOOL_F, |
| 814 | SCM_BOOL_F, |
| 815 | highlights); |
| 816 | scm_newline (scm_cur_outp); |
| 817 | if (scm_is_false (SCM_VARIABLE_REF (scm_has_shown_backtrace_hint_p_var)) |
| 818 | && !SCM_BACKTRACE_P) |
| 819 | { |
| 820 | scm_puts ("Type \"(debug-enable 'backtrace)\" if you would like " |
| 821 | "a backtrace\n" |
| 822 | "automatically if an error occurs in the future.\n", |
| 823 | scm_cur_outp); |
| 824 | SCM_VARIABLE_SET (scm_has_shown_backtrace_hint_p_var, SCM_BOOL_T); |
| 825 | } |
| 826 | } |
| 827 | else |
| 828 | { |
| 829 | scm_puts ("No backtrace available.\n", scm_cur_outp); |
| 830 | } |
| 831 | return SCM_UNSPECIFIED; |
| 832 | } |
| 833 | #undef FUNC_NAME |
| 834 | |
| 835 | SCM |
| 836 | scm_backtrace (void) |
| 837 | { |
| 838 | return scm_backtrace_with_highlights (SCM_EOL); |
| 839 | } |
| 840 | |
| 841 | \f |
| 842 | |
| 843 | void |
| 844 | scm_init_backtrace () |
| 845 | { |
| 846 | SCM f = scm_make_fluid (); |
| 847 | scm_the_last_stack_fluid_var = scm_c_define ("the-last-stack", f); |
| 848 | |
| 849 | #include "libguile/backtrace.x" |
| 850 | } |
| 851 | |
| 852 | /* |
| 853 | Local Variables: |
| 854 | c-file-style: "gnu" |
| 855 | End: |
| 856 | */ |