*** empty log message ***
[bpt/guile.git] / libguile / backtrace.c
index a602d91..ab96ba5 100644 (file)
@@ -1,52 +1,26 @@
 /* Printing of backtraces and error messages
- * Copyright (C) 1996, 1997, 1998, 1999, 2000 Free Software Foundation
+ * Copyright (C) 1996,1997,1998,1999,2000,2001, 2003 Free Software Foundation
  *
- * 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 library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
+ * This library 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.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser 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, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 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.
- *
- * The author can be reached at djurfeldt@nada.kth.se
- * Mikael Djurfeldt, SANS/NADA KTH, 10044 STOCKHOLM, SWEDEN */
-
-/* Software engineering face-lift by Greg J. Badros, 11-Dec-1999,
-   gjb@cs.washington.edu, http://www.cs.washington.edu/homes/gjb */
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
 
+#if HAVE_CONFIG_H
+#  include <config.h>
+#endif
 
+#include <stdio.h>
 #include <ctype.h>
 
 #include "libguile/_scm.h"
@@ -54,6 +28,9 @@
 #ifdef HAVE_UNISTD_H
 #include <unistd.h>
 #endif
+#ifdef HAVE_IO_H
+#include <io.h>
+#endif
 
 #include "libguile/stacks.h"
 #include "libguile/srcprop.h"
 #include "libguile/fluids.h"
 #include "libguile/ports.h"
 #include "libguile/strings.h"
+#include "libguile/dynwind.h"
 
 #include "libguile/validate.h"
+#include "libguile/lang.h"
 #include "libguile/backtrace.h"
 #include "libguile/filesys.h"
 
 /* {Error reporting and backtraces}
- * (A first approximation.)
  *
  * Note that these functions shouldn't generate errors themselves.
  */
 
-#ifndef SCM_RECKLESS
+/* Print parameters for error messages. */
+
+#define DISPLAY_ERROR_MESSAGE_MAX_LEVEL   7
+#define DISPLAY_ERROR_MESSAGE_MAX_LENGTH 10
+
+/* Print parameters for failing expressions in error messages.
+ * (See also `print_params' below for backtrace print parameters.)
+ */
+
+#define DISPLAY_EXPRESSION_MAX_LEVEL      2
+#define DISPLAY_EXPRESSION_MAX_LENGTH     3
+
 #undef SCM_ASSERT
 #define SCM_ASSERT(_cond, _arg, _pos, _subr) \
        if (!(_cond)) \
           return SCM_BOOL_F;
-#endif
 
 SCM scm_the_last_stack_fluid_var;
 
@@ -115,30 +103,79 @@ display_header (SCM source, SCM port)
 }
 
 
+struct display_error_message_data {
+  SCM message;
+  SCM args;
+  SCM port;
+  scm_print_state *pstate;
+  int old_fancyp;
+  int old_level;
+  int old_length;
+};
+
+static SCM
+display_error_message (struct display_error_message_data *d)
+{
+  if (SCM_STRINGP (d->message) && !SCM_FALSEP (scm_list_p (d->args)))
+    scm_simple_format (d->port, d->message, d->args);
+  else
+    scm_display (d->message, d->port);
+  scm_newline (d->port);
+  return SCM_UNSPECIFIED;
+}
+
+static void
+before_display_error_message (struct display_error_message_data *d)
+{
+  scm_print_state *pstate = d->pstate;
+  d->old_fancyp = pstate->fancyp;
+  d->old_level  = pstate->level;
+  d->old_length = pstate->length;
+  pstate->fancyp = 1;
+  pstate->level  = DISPLAY_ERROR_MESSAGE_MAX_LEVEL;
+  pstate->length = DISPLAY_ERROR_MESSAGE_MAX_LENGTH;
+}
+
+static void
+after_display_error_message (struct display_error_message_data *d)
+{
+  scm_print_state *pstate = d->pstate;
+  pstate->fancyp = d->old_fancyp;
+  pstate->level  = d->old_level;
+  pstate->length = d->old_length;
+}
+
 void
 scm_display_error_message (SCM message, SCM args, SCM port)
 {
-  if (SCM_STRINGP (message) && !SCM_FALSEP (scm_list_p (args)))
-    {
-      scm_simple_format (port, message, args);
-      scm_newline (port);
-    }
-  else
-    {
-      scm_display (message, port);
-      scm_newline (port);
-    }
+  struct display_error_message_data d;
+  SCM print_state;
+  scm_print_state *pstate;
+
+  port = scm_i_port_with_print_state (port, SCM_UNDEFINED);
+  print_state = SCM_PORT_WITH_PS_PS (port);
+  pstate = SCM_PRINT_STATE (print_state);
+  
+  d.message = message;
+  d.args = args;
+  d.port = port;
+  d.pstate = pstate;
+  scm_internal_dynamic_wind ((scm_t_guard) before_display_error_message,
+                            (scm_t_inner) display_error_message,
+                            (scm_t_guard) after_display_error_message,
+                            &d,
+                            &d);
 }
 
 static void
-display_expression (SCM frame,SCM pname,SCM source,SCM port)
+display_expression (SCM frame, SCM pname, SCM source, SCM port)
 {
   SCM print_state = scm_make_print_state ();
   scm_print_state *pstate = SCM_PRINT_STATE (print_state);
   pstate->writingp = 0;
   pstate->fancyp = 1;
-  pstate->level = 2;
-  pstate->length = 3;
+  pstate->level  = DISPLAY_EXPRESSION_MAX_LEVEL;
+  pstate->length = DISPLAY_EXPRESSION_MAX_LENGTH;
   if (SCM_SYMBOLP (pname) || SCM_STRINGP (pname))
     {
       if (SCM_FRAMEP (frame)
@@ -154,7 +191,7 @@ display_expression (SCM frame,SCM pname,SCM source,SCM port)
          scm_iprin1 (scm_unmemoize (source), port, pstate);
        }
     }
-  else if (SCM_NIMP (source))
+  else if (SCM_MEMOIZEDP (source))
     {
       scm_puts ("In expression ", port);
       pstate->writingp = 1;
@@ -181,7 +218,7 @@ display_error_body (struct display_error_args *a)
   SCM prev_frame = SCM_BOOL_F;
   SCM pname = a->subr;
 
-  if (SCM_DEBUGGINGP
+  if (scm_debug_mode_p
       && SCM_STACKP (a->stack)
       && SCM_STACK_LENGTH (a->stack) > 0)
     {
@@ -216,7 +253,7 @@ struct display_error_handler_data {
    try to print all objects, we would enter an infinite loop. */
 static SCM
 display_error_handler (struct display_error_handler_data *data,
-                      SCM tag, SCM args)
+                      SCM tag, SCM args SCM_UNUSED)
 {
   SCM print_state = scm_make_print_state ();
   scm_puts ("\nException during displaying of ", data->port);
@@ -247,8 +284,8 @@ scm_i_display_error (SCM stack, SCM port, SCM subr, SCM message, SCM args, SCM r
   data.mode = "error";
   data.port = port;
   scm_internal_catch (SCM_BOOL_T,
-                     (scm_catch_body_t) display_error_body, &a,
-                     (scm_catch_handler_t) display_error_handler, &data);
+                     (scm_t_catch_body) display_error_body, &a,
+                     (scm_t_catch_handler) display_error_handler, &data);
 }
 
 
@@ -256,7 +293,7 @@ SCM_DEFINE (scm_display_error, "display-error", 6, 0, 0,
            (SCM stack, SCM port, SCM subr, SCM message, SCM args, SCM rest),
            "Display an error message to the output port @var{port}.\n"
            "@var{stack} is the saved stack for the error, @var{subr} is\n"
-           "the name of the procedure in which the error occured and\n"
+           "the name of the procedure in which the error occurred and\n"
            "@var{message} is the actual error message, which may contain\n"
            "formatting instructions. These will format the arguments in\n"
            "the list @var{args} accordingly.  @var{rest} is currently\n"
@@ -300,7 +337,7 @@ SCM_DEFINE (scm_set_print_params_x, "set-print-params!", 1, 0, 0,
   print_params_t *new_params;
 
   SCM_VALIDATE_NONEMPTYLIST_COPYLEN (2, params, n);
-  for (ls = params; SCM_NNULLP (ls); ls = SCM_CDR (ls))
+  for (ls = params; !SCM_NULL_OR_NIL_P (ls); ls = SCM_CDR (ls))
     SCM_ASSERT (scm_ilength (SCM_CAR (params)) == 2
                && SCM_INUMP (SCM_CAAR (ls))
                && SCM_INUM (SCM_CAAR (ls)) >= 0
@@ -309,10 +346,9 @@ SCM_DEFINE (scm_set_print_params_x, "set-print-params!", 1, 0, 0,
                params,
                SCM_ARG2,
                s_scm_set_print_params_x);
-  new_params = scm_must_malloc (n * sizeof (print_params_t),
-                               FUNC_NAME);
+  new_params = scm_malloc (n * sizeof (print_params_t));
   if (print_params != default_print_params)
-    scm_must_free (print_params);
+    free (print_params);
   print_params = new_params;
   for (i = 0; i < n; ++i)
     {
@@ -335,11 +371,11 @@ indent (int n, SCM port)
 }
 
 static void
-display_frame_expr (char *hdr,SCM exp,char *tlr,int indentation,SCM sport,SCM port,scm_print_state *pstate)
+display_frame_expr (char *hdr, SCM exp, char *tlr, int indentation, SCM sport, SCM port, scm_print_state *pstate)
 {
   SCM string;
   int i = 0, n;
-  scm_ptob_descriptor_t *ptob = scm_ptobs + SCM_PTOBNUM (sport);
+  scm_t_ptob_descriptor *ptob = scm_ptobs + SCM_PTOBNUM (sport);
   do
     {
       pstate->length = print_params[i].length;
@@ -377,14 +413,14 @@ display_frame_expr (char *hdr,SCM exp,char *tlr,int indentation,SCM sport,SCM po
 }
 
 static void
-display_application (SCM frame,int indentation,SCM sport,SCM port,scm_print_state *pstate)
+display_application (SCM frame, int indentation, SCM sport, SCM port, scm_print_state *pstate)
 {
   SCM proc = SCM_FRAME_PROC (frame);
-  SCM name = (SCM_NFALSEP (scm_procedure_p (proc))
+  SCM name = (!SCM_FALSEP (scm_procedure_p (proc))
              ? scm_procedure_name (proc)
              : SCM_BOOL_F);
   display_frame_expr ("[",
-                     scm_cons (SCM_NFALSEP (name) ? name : proc,
+                     scm_cons (!SCM_FALSEP (name) ? name : proc,
                                SCM_FRAME_ARGS (frame)),
                      SCM_FRAME_EVAL_ARGS_P (frame) ? " ..." : "]",
                      indentation,
@@ -400,15 +436,15 @@ SCM_DEFINE (scm_display_application, "display-application", 1, 2, 0,
            "output.")
 #define FUNC_NAME s_scm_display_application
 {
-  SCM_VALIDATE_FRAME (1,frame);
+  SCM_VALIDATE_FRAME (1, frame);
   if (SCM_UNBNDP (port))
     port = scm_cur_outp;
   else
-    SCM_VALIDATE_OPOUTPORT (2,port);
+    SCM_VALIDATE_OPOUTPORT (2, port);
   if (SCM_UNBNDP (indent))
     indent = SCM_INUM0;
   else
-    SCM_VALIDATE_INUM (3,indent);
+    SCM_VALIDATE_INUM (3, indent);
   
   if (SCM_FRAME_PROC_P (frame))
     /* Display an application. */
@@ -458,14 +494,14 @@ display_backtrace_file (frame, last_file, port, pstate)
 
   display_backtrace_get_file_line (frame, &file, &line);
 
-  if (file == *last_file)
+  if (SCM_EQ_P (file, *last_file))
     return;
 
   *last_file = file;
 
   scm_puts ("In ", port);
-  if (file == SCM_BOOL_F)
-    if (line == SCM_BOOL_F)
+  if (SCM_FALSEP (file))
+    if (SCM_FALSEP (line))
       scm_puts ("unknown file", port);
     else
       scm_puts ("current input", port);
@@ -485,11 +521,11 @@ display_backtrace_file_and_line (SCM frame, SCM port, scm_print_state *pstate)
 
   display_backtrace_get_file_line (frame, &file, &line);
 
-  if (SCM_EQ_P (SCM_SHOW_FILE_NAME, sym_base))
+  if (SCM_EQ_P (SCM_PACK (SCM_SHOW_FILE_NAME), sym_base))
     {
-      if (file == SCM_BOOL_F)
+      if (SCM_FALSEP (file))
        {
-         if (line == SCM_BOOL_F)
+         if (SCM_FALSEP (line))
            scm_putc ('?', port);
          else
            scm_puts ("<stdin>", port);
@@ -497,14 +533,18 @@ display_backtrace_file_and_line (SCM frame, SCM port, scm_print_state *pstate)
       else
        {
          pstate -> writingp = 0;
+#ifdef HAVE_POSIX
          scm_iprin1 (SCM_STRINGP (file) ? scm_basename (file, SCM_UNDEFINED) : file,
                      port, pstate);
+#else
+         scm_iprin1 (file, port, pstate);
+#endif
          pstate -> writingp = 1;
        }
 
       scm_putc (':', port);
     }
-  else if (line != SCM_BOOL_F)
+  else if (!SCM_FALSEP (line))
     {
       int i, j=0;
       for (i = SCM_INUM (line)+1; i > 0; i = i/10, j++)
@@ -512,7 +552,7 @@ display_backtrace_file_and_line (SCM frame, SCM port, scm_print_state *pstate)
       indent (4-j, port);
     }
 
-  if (line == SCM_BOOL_F)
+  if (SCM_FALSEP (line))
     scm_puts ("   ?", port);
   else
     scm_intprint (SCM_INUM (line) + 1, 10, port);
@@ -520,7 +560,7 @@ display_backtrace_file_and_line (SCM frame, SCM port, scm_print_state *pstate)
 }
 
 static void
-display_frame (SCM frame,int nfield,int indentation,SCM sport,SCM port,scm_print_state *pstate)
+display_frame (SCM frame, int nfield, int indentation, SCM sport, SCM port, scm_print_state *pstate)
 {
   int n, i, j;
 
@@ -532,7 +572,7 @@ display_frame (SCM frame,int nfield,int indentation,SCM sport,SCM port,scm_print
     }
 
   /* display file name and line number */
-  if (SCM_NFALSEP (SCM_SHOW_FILE_NAME))
+  if (!SCM_FALSEP (SCM_PACK (SCM_SHOW_FILE_NAME)))
     display_backtrace_file_and_line (frame, port, pstate);
 
   /* Check size of frame number. */
@@ -590,7 +630,7 @@ struct display_backtrace_args {
 };
 
 static SCM
-display_backtrace_body(struct display_backtrace_args *a)
+display_backtrace_body (struct display_backtrace_args *a)
 #define FUNC_NAME "display_backtrace_body"
 {
   int n_frames, beg, end, n, i, j;
@@ -602,14 +642,8 @@ display_backtrace_body(struct display_backtrace_args *a)
   a->port = SCM_COERCE_OUTPORT (a->port);
 
   /* Argument checking and extraction. */
-  SCM_ASSERT (SCM_STACKP (a->stack),
-             a->stack,
-             SCM_ARG1,
-             s_display_backtrace);
-  SCM_ASSERT (SCM_OPOUTPORTP (a->port),
-             a->port,
-             SCM_ARG2,
-             s_display_backtrace);
+  SCM_VALIDATE_STACK (1, a->stack);
+  SCM_VALIDATE_OPOUTPORT (2, a->port);
   n_frames = SCM_INUM (scm_stack_length (a->stack));
   n = SCM_INUMP (a->depth) ? SCM_INUM (a->depth) : SCM_BACKTRACE_DEPTH;
   if (SCM_BACKWARDS_P)
@@ -658,6 +692,8 @@ display_backtrace_body(struct display_backtrace_args *a)
     indent_p = 0;
   else
     {
+      unsigned int j;
+
       indent_p = 1;
       frame = scm_stack_ref (a->stack, SCM_MAKINUM (beg));
       for (i = 0, j = 0; i < n; ++i)
@@ -686,7 +722,7 @@ display_backtrace_body(struct display_backtrace_args *a)
   last_file = SCM_UNDEFINED;
   for (i = 0; i < n; ++i)
     {
-      if (!SCM_EQ_P (SCM_SHOW_FILE_NAME, sym_base))
+      if (!SCM_EQ_P (SCM_PACK (SCM_SHOW_FILE_NAME), sym_base))
        display_backtrace_file (frame, &last_file, a->port, pstate);
 
       display_frame (frame, nfield, indentation, sport, a->port, pstate);
@@ -720,8 +756,8 @@ SCM_DEFINE (scm_display_backtrace, "display-backtrace", 2, 2, 0,
   data.mode = "backtrace";
   data.port = port;
   scm_internal_catch (SCM_BOOL_T,
-                     (scm_catch_body_t) display_backtrace_body, &a,
-                     (scm_catch_handler_t) display_error_handler, &data);
+                     (scm_t_catch_body) display_backtrace_body, &a,
+                     (scm_t_catch_handler) display_error_handler, &data);
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
@@ -736,7 +772,7 @@ SCM_DEFINE (scm_backtrace, "backtrace", 0, 0, 0,
 {
   SCM the_last_stack =
     scm_fluid_ref (SCM_VARIABLE_REF (scm_the_last_stack_fluid_var));
-  if (SCM_NFALSEP (the_last_stack))
+  if (!SCM_FALSEP (the_last_stack))
     {
       scm_newline (scm_cur_outp);
       scm_puts ("Backtrace:\n", scm_cur_outp);
@@ -771,9 +807,7 @@ scm_init_backtrace ()
   SCM f = scm_make_fluid ();
   scm_the_last_stack_fluid_var = scm_c_define ("the-last-stack", f);
 
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/backtrace.x"
-#endif
 }
 
 /*