Also install perlbug as perlthanks, to make it easy for people to send

[perl5.git] / deb.c

diff --git a/deb.c b/deb.c
index f268216..bc7e419 100644 (file)
--- a/deb.c
+++ b/deb.c
@@ -1,7 +1,7 @@
 /*    deb.c
  *
- *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999,
- *    2000, 2001, 2002, by Larry Wall and others
+ *    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000,
+ *    2001, 2002, 2003, 2004, 2005, 2006, 2007, by Larry Wall and others
  *
  *    You may distribute under the terms of either the GNU General Public
  *    License or the Artistic License, as specified in the README file.
@@ -13,6 +13,11 @@
  * have seen more than thou knowest, Gray Fool."  --Denethor
  */
 
+/*
+ * This file contains various utilities for producing debugging output
+ * (mainly related to displaying the stack)
+ */
+
 #include "EXTERN.h"
 #define PERL_IN_DEB_C
 #include "perl.h"
@@ -24,9 +29,12 @@ Perl_deb_nocontext(const char *pat, ...)
 #ifdef DEBUGGING
     dTHX;
     va_list args;
+    PERL_ARGS_ASSERT_DEB_NOCONTEXT;
     va_start(args, pat);
     vdeb(pat, &args);
     va_end(args);
+#else
+    PERL_UNUSED_ARG(pat);
 #endif /* DEBUGGING */
 }
 #endif
@@ -34,23 +42,38 @@ Perl_deb_nocontext(const char *pat, ...)
 void
 Perl_deb(pTHX_ const char *pat, ...)
 {
-#ifdef DEBUGGING
     va_list args;
+    PERL_ARGS_ASSERT_DEB;
     va_start(args, pat);
+#ifdef DEBUGGING
     vdeb(pat, &args);
-    va_end(args);
+#else
+    PERL_UNUSED_CONTEXT;
 #endif /* DEBUGGING */
+    va_end(args);
 }
 
 void
 Perl_vdeb(pTHX_ const char *pat, va_list *args)
 {
 #ifdef DEBUGGING
-    char* file = OutCopFILE(PL_curcop);
-
-    PerlIO_printf(Perl_debug_log, "(%s:%ld)\t", (file ? file : "<free>"),
-                 (long)CopLINE(PL_curcop));
+    dVAR;
+    const char* const file = PL_curcop ? OutCopFILE(PL_curcop) : "<null>";
+    const char* const display_file = file ? file : "<free>";
+    const long line = PL_curcop ? (long)CopLINE(PL_curcop) : 0;
+
+    PERL_ARGS_ASSERT_VDEB;
+
+    if (DEBUG_v_TEST)
+       PerlIO_printf(Perl_debug_log, "(%ld:%s:%ld)\t",
+                     (long)PerlProc_getpid(), display_file, line);
+    else
+       PerlIO_printf(Perl_debug_log, "(%s:%ld)\t", display_file, line);
     (void) PerlIO_vprintf(Perl_debug_log, pat, *args);
+#else
+    PERL_UNUSED_CONTEXT;
+    PERL_UNUSED_ARG(pat);
+    PERL_UNUSED_ARG(args);
 #endif /* DEBUGGING */
 }
 
@@ -58,6 +81,7 @@ I32
 Perl_debstackptrs(pTHX)
 {
 #ifdef DEBUGGING
+    dVAR;
     PerlIO_printf(Perl_debug_log,
                  "%8"UVxf" %8"UVxf" %8"IVdf" %8"IVdf" %8"IVdf"\n",
                  PTR2UV(PL_curstack), PTR2UV(PL_stack_base),
@@ -87,8 +111,12 @@ S_deb_stack_n(pTHX_ SV** stack_base, I32 stack_min, I32 stack_max,
        I32 mark_min, I32 mark_max)
 {
 #ifdef DEBUGGING
+    dVAR;
     register I32 i = stack_max - 30;
-    I32 *markscan = PL_markstack + mark_min;
+    const I32 *markscan = PL_markstack + mark_min;
+
+    PERL_ARGS_ASSERT_DEB_STACK_N;
+
     if (i < stack_min)
        i = stack_min;
     
@@ -117,6 +145,13 @@ S_deb_stack_n(pTHX_ SV** stack_base, I32 stack_min, I32 stack_max,
     }
     while (1);
     PerlIO_printf(Perl_debug_log, "\n");
+#else
+    PERL_UNUSED_CONTEXT;
+    PERL_UNUSED_ARG(stack_base);
+    PERL_UNUSED_ARG(stack_min);
+    PERL_UNUSED_ARG(stack_max);
+    PERL_UNUSED_ARG(mark_min);
+    PERL_UNUSED_ARG(mark_max);
 #endif /* DEBUGGING */
 }
 
@@ -127,6 +162,7 @@ I32
 Perl_debstack(pTHX)
 {
 #ifndef SKIP_DEBUGGING
+    dVAR;
     if (CopSTASH_eq(PL_curcop, PL_debstash) && !DEBUG_J_TEST_)
        return 0;
 
@@ -144,7 +180,7 @@ Perl_debstack(pTHX)
 
 
 #ifdef DEBUGGING
-static char * si_names[] = {
+static const char * const si_names[] = {
     "UNKNOWN",
     "UNDEF",
     "MAIN",
@@ -166,9 +202,9 @@ void
 Perl_deb_stack_all(pTHX)
 {
 #ifdef DEBUGGING
-    I32                 ix, si_ix;
-    PERL_SI     *si;
-    PERL_CONTEXT *cx;
+    dVAR;
+    I32 si_ix;
+    const PERL_SI *si;
 
     /* rewind to start of chain */
     si = PL_curstackinfo;
@@ -178,18 +214,15 @@ Perl_deb_stack_all(pTHX)
     si_ix=0;
     for (;;)
     {
-       char *si_name;
-       int si_name_ix = si->si_type+1; /* -1 is a valid index */
-       if (si_name_ix>= sizeof(si_names))
-           si_name = "????";
-       else
-           si_name = si_names[si_name_ix];
+        const size_t si_name_ix = si->si_type+1; /* -1 is a valid index */
+        const char * const si_name = (si_name_ix >= sizeof(si_names)) ? "????" : si_names[si_name_ix];
+       I32 ix;
        PerlIO_printf(Perl_debug_log, "STACK %"IVdf": %s\n",
                                                (IV)si_ix, si_name);
 
        for (ix=0; ix<=si->si_cxix; ix++) {
 
-           cx = &(si->si_cxstack[ix]);
+           const PERL_CONTEXT * const cx = &(si->si_cxstack[ix]);
            PerlIO_printf(Perl_debug_log,
                    "  CX %"IVdf": %-6s => ",
                    (IV)ix, PL_block_type[CxTYPE(cx)]
@@ -206,11 +239,8 @@ Perl_deb_stack_all(pTHX)
                 */
 
                I32 i, stack_min, stack_max, mark_min, mark_max;
-               PERL_CONTEXT *cx_n;
-               PERL_SI      *si_n;
-               OP           *retop;
-
-               cx_n = Null(PERL_CONTEXT*);
+               const PERL_CONTEXT *cx_n = NULL;
+               const PERL_SI *si_n;
 
                /* there's a separate stack per SI, so only search
                 * this one */
@@ -239,7 +269,7 @@ Perl_deb_stack_all(pTHX)
 
                si_n = si;
                i = ix;
-               cx_n = Null(PERL_CONTEXT*);
+               cx_n = NULL;
                for (;;) {
                    i++;
                    if (i > si_n->si_cxix) {
@@ -270,8 +300,7 @@ Perl_deb_stack_all(pTHX)
                if (CxTYPE(cx) == CXt_EVAL || CxTYPE(cx) == CXt_SUB
                        || CxTYPE(cx) == CXt_FORMAT)
                {
-                   retop = (CxTYPE(cx) == CXt_EVAL)
-                           ? cx->blk_eval.retop : cx->blk_sub.retop;
+                   const OP * const retop = cx->blk_sub.retop;
 
                    PerlIO_printf(Perl_debug_log, "  retop=%s\n",
                            retop ? OP_NAME(retop) : "(null)"
@@ -290,7 +319,17 @@ Perl_deb_stack_all(pTHX)
     } /* next stackinfo */
 
     PerlIO_printf(Perl_debug_log, "\n");
+#else
+    PERL_UNUSED_CONTEXT;
 #endif /* DEBUGGING */
 }
 
-
+/*
+ * Local variables:
+ * c-indentation-style: bsd
+ * c-basic-offset: 4
+ * indent-tabs-mode: t
+ * End:
+ *
+ * ex: set ts=8 sts=4 sw=4 noet:
+ */