Don't count on 'trap 0' inside () in shell script
[perl.git] / dump.c
1 /*    dump.c
2  *
3  *    Copyright (c) 1991-1997, Larry Wall
4  *
5  *    You may distribute under the terms of either the GNU General Public
6  *    License or the Artistic License, as specified in the README file.
7  *
8  */
9
10 /*
11  * "'You have talked long in your sleep, Frodo,' said Gandalf gently, 'and
12  * it has not been hard for me to read your mind and memory.'"
13  */
14
15 #include "EXTERN.h"
16 #include "perl.h"
17
18 #ifndef DEBUGGING
19 void
20 dump_all()
21 {
22 }
23 #else  /* Rest of file is for DEBUGGING */
24
25 #ifdef I_STDARG
26 static void dump(char *pat, ...);
27 #else
28 static void dump();
29 #endif
30
31 void
32 dump_all()
33 {
34     PerlIO_setlinebuf(Perl_debug_log);
35     if (main_root)
36         dump_op(main_root);
37     dump_packsubs(defstash);
38 }
39
40 void
41 dump_packsubs(stash)
42 HV* stash;
43 {
44     I32 i;
45     HE  *entry;
46
47     if (!HvARRAY(stash))
48         return;
49     for (i = 0; i <= (I32) HvMAX(stash); i++) {
50         for (entry = HvARRAY(stash)[i]; entry; entry = HeNEXT(entry)) {
51             GV *gv = (GV*)HeVAL(entry);
52             HV *hv;
53             if (GvCVu(gv))
54                 dump_sub(gv);
55             if (GvFORM(gv))
56                 dump_form(gv);
57             if (HeKEY(entry)[HeKLEN(entry)-1] == ':' &&
58               (hv = GvHV(gv)) && HvNAME(hv) && hv != defstash)
59                 dump_packsubs(hv);              /* nested package */
60         }
61     }
62 }
63
64 void
65 dump_sub(gv)
66 GV* gv;
67 {
68     SV *sv = sv_newmortal();
69
70     gv_fullname3(sv, gv, Nullch);
71     dump("\nSUB %s = ", SvPVX(sv));
72     if (CvXSUB(GvCV(gv)))
73         dump("(xsub 0x%x %d)\n",
74             (long)CvXSUB(GvCV(gv)),
75             CvXSUBANY(GvCV(gv)).any_i32);
76     else if (CvROOT(GvCV(gv)))
77         dump_op(CvROOT(GvCV(gv)));
78     else
79         dump("<undef>\n");
80 }
81
82 void
83 dump_form(gv)
84 GV* gv;
85 {
86     SV *sv = sv_newmortal();
87
88     gv_fullname3(sv, gv, Nullch);
89     dump("\nFORMAT %s = ", SvPVX(sv));
90     if (CvROOT(GvFORM(gv)))
91         dump_op(CvROOT(GvFORM(gv)));
92     else
93         dump("<undef>\n");
94 }
95
96 void
97 dump_eval()
98 {
99     dump_op(eval_root);
100 }
101
102 void
103 dump_op(op)
104 register OP *op;
105 {
106     SV *tmpsv;
107
108     dump("{\n");
109     if (op->op_seq)
110         PerlIO_printf(Perl_debug_log, "%-4d", op->op_seq);
111     else
112         PerlIO_printf(Perl_debug_log, "    ");
113     dump("TYPE = %s  ===> ", op_name[op->op_type]);
114     if (op->op_next) {
115         if (op->op_seq)
116             PerlIO_printf(Perl_debug_log, "%d\n", op->op_next->op_seq);
117         else
118             PerlIO_printf(Perl_debug_log, "(%d)\n", op->op_next->op_seq);
119     }
120     else
121         PerlIO_printf(Perl_debug_log, "DONE\n");
122     dumplvl++;
123     if (op->op_targ) {
124         if (op->op_type == OP_NULL)
125             dump("  (was %s)\n", op_name[op->op_targ]);
126         else
127             dump("TARG = %d\n", op->op_targ);
128     }
129 #ifdef DUMPADDR
130     dump("ADDR = 0x%lx => 0x%lx\n",op, op->op_next);
131 #endif
132     if (op->op_flags) {
133         *buf = '\0';
134         if (op->op_flags & OPf_KNOW) {
135             if (op->op_flags & OPf_LIST)
136                 (void)strcat(buf,"LIST,");
137             else
138                 (void)strcat(buf,"SCALAR,");
139         }
140         else
141             (void)strcat(buf,"UNKNOWN,");
142         if (op->op_flags & OPf_KIDS)
143             (void)strcat(buf,"KIDS,");
144         if (op->op_flags & OPf_PARENS)
145             (void)strcat(buf,"PARENS,");
146         if (op->op_flags & OPf_STACKED)
147             (void)strcat(buf,"STACKED,");
148         if (op->op_flags & OPf_REF)
149             (void)strcat(buf,"REF,");
150         if (op->op_flags & OPf_MOD)
151             (void)strcat(buf,"MOD,");
152         if (op->op_flags & OPf_SPECIAL)
153             (void)strcat(buf,"SPECIAL,");
154         if (*buf)
155             buf[strlen(buf)-1] = '\0';
156         dump("FLAGS = (%s)\n",buf);
157     }
158     if (op->op_private) {
159         *buf = '\0';
160         if (op->op_type == OP_AASSIGN) {
161             if (op->op_private & OPpASSIGN_COMMON)
162                 (void)strcat(buf,"COMMON,");
163         }
164         else if (op->op_type == OP_SASSIGN) {
165             if (op->op_private & OPpASSIGN_BACKWARDS)
166                 (void)strcat(buf,"BACKWARDS,");
167         }
168         else if (op->op_type == OP_TRANS) {
169             if (op->op_private & OPpTRANS_SQUASH)
170                 (void)strcat(buf,"SQUASH,");
171             if (op->op_private & OPpTRANS_DELETE)
172                 (void)strcat(buf,"DELETE,");
173             if (op->op_private & OPpTRANS_COMPLEMENT)
174                 (void)strcat(buf,"COMPLEMENT,");
175         }
176         else if (op->op_type == OP_REPEAT) {
177             if (op->op_private & OPpREPEAT_DOLIST)
178                 (void)strcat(buf,"DOLIST,");
179         }
180         else if (op->op_type == OP_ENTERSUB ||
181                  op->op_type == OP_RV2SV ||
182                  op->op_type == OP_RV2AV ||
183                  op->op_type == OP_RV2HV ||
184                  op->op_type == OP_RV2GV ||
185                  op->op_type == OP_AELEM ||
186                  op->op_type == OP_HELEM )
187         {
188             if (op->op_private & OPpENTERSUB_AMPER)
189                 (void)strcat(buf,"AMPER,");
190             if (op->op_private & OPpENTERSUB_DB)
191                 (void)strcat(buf,"DB,");
192             switch (op->op_private & OPpDEREF) {
193             case OPpDEREF_SV:
194                 (void)strcat(buf, "SV,");
195                 break;
196             case OPpDEREF_AV:
197                 (void)strcat(buf, "AV,");
198                 break;
199             case OPpDEREF_HV:
200                 (void)strcat(buf, "HV,");
201                 break;
202             }
203             if (op->op_private & HINT_STRICT_REFS)
204                 (void)strcat(buf,"STRICT_REFS,");
205         }
206         else if (op->op_type == OP_CONST) {
207             if (op->op_private & OPpCONST_BARE)
208                 (void)strcat(buf,"BARE,");
209         }
210         else if (op->op_type == OP_FLIP) {
211             if (op->op_private & OPpFLIP_LINENUM)
212                 (void)strcat(buf,"LINENUM,");
213         }
214         else if (op->op_type == OP_FLOP) {
215             if (op->op_private & OPpFLIP_LINENUM)
216                 (void)strcat(buf,"LINENUM,");
217         }
218         if (op->op_flags & OPf_MOD && op->op_private & OPpLVAL_INTRO)
219             (void)strcat(buf,"INTRO,");
220         if (*buf) {
221             buf[strlen(buf)-1] = '\0';
222             dump("PRIVATE = (%s)\n",buf);
223         }
224     }
225
226     switch (op->op_type) {
227     case OP_GVSV:
228     case OP_GV:
229         if (cGVOP->op_gv) {
230             ENTER;
231             tmpsv = NEWSV(0,0);
232             SAVEFREESV(tmpsv);
233             gv_fullname3(tmpsv, cGVOP->op_gv, Nullch);
234             dump("GV = %s\n", SvPV(tmpsv, na));
235             LEAVE;
236         }
237         else
238             dump("GV = NULL\n");
239         break;
240     case OP_CONST:
241         dump("SV = %s\n", SvPEEK(cSVOP->op_sv));
242         break;
243     case OP_NEXTSTATE:
244     case OP_DBSTATE:
245         if (cCOP->cop_line)
246             dump("LINE = %d\n",cCOP->cop_line);
247         if (cCOP->cop_label)
248             dump("LABEL = \"%s\"\n",cCOP->cop_label);
249         break;
250     case OP_ENTERLOOP:
251         dump("REDO ===> ");
252         if (cLOOP->op_redoop)
253             PerlIO_printf(Perl_debug_log, "%d\n", cLOOP->op_redoop->op_seq);
254         else
255             PerlIO_printf(Perl_debug_log, "DONE\n");
256         dump("NEXT ===> ");
257         if (cLOOP->op_nextop)
258             PerlIO_printf(Perl_debug_log, "%d\n", cLOOP->op_nextop->op_seq);
259         else
260             PerlIO_printf(Perl_debug_log, "DONE\n");
261         dump("LAST ===> ");
262         if (cLOOP->op_lastop)
263             PerlIO_printf(Perl_debug_log, "%d\n", cLOOP->op_lastop->op_seq);
264         else
265             PerlIO_printf(Perl_debug_log, "DONE\n");
266         break;
267     case OP_COND_EXPR:
268         dump("TRUE ===> ");
269         if (cCONDOP->op_true)
270             PerlIO_printf(Perl_debug_log, "%d\n", cCONDOP->op_true->op_seq);
271         else
272             PerlIO_printf(Perl_debug_log, "DONE\n");
273         dump("FALSE ===> ");
274         if (cCONDOP->op_false)
275             PerlIO_printf(Perl_debug_log, "%d\n", cCONDOP->op_false->op_seq);
276         else
277             PerlIO_printf(Perl_debug_log, "DONE\n");
278         break;
279     case OP_MAPWHILE:
280     case OP_GREPWHILE:
281     case OP_OR:
282     case OP_AND:
283         dump("OTHER ===> ");
284         if (cLOGOP->op_other)
285             PerlIO_printf(Perl_debug_log, "%d\n", cLOGOP->op_other->op_seq);
286         else
287             PerlIO_printf(Perl_debug_log, "DONE\n");
288         break;
289     case OP_PUSHRE:
290     case OP_MATCH:
291     case OP_SUBST:
292         dump_pm((PMOP*)op);
293         break;
294     default:
295         break;
296     }
297     if (op->op_flags & OPf_KIDS) {
298         OP *kid;
299         for (kid = cUNOP->op_first; kid; kid = kid->op_sibling)
300             dump_op(kid);
301     }
302     dumplvl--;
303     dump("}\n");
304 }
305
306 void
307 dump_gv(gv)
308 register GV *gv;
309 {
310     SV *sv;
311
312     if (!gv) {
313         PerlIO_printf(Perl_debug_log, "{}\n");
314         return;
315     }
316     sv = sv_newmortal();
317     dumplvl++;
318     PerlIO_printf(Perl_debug_log, "{\n");
319     gv_fullname3(sv, gv, Nullch);
320     dump("GV_NAME = %s", SvPVX(sv));
321     if (gv != GvEGV(gv)) {
322         gv_efullname3(sv, GvEGV(gv), Nullch);
323         dump("-> %s", SvPVX(sv));
324     }
325     dump("\n");
326     dumplvl--;
327     dump("}\n");
328 }
329
330 void
331 dump_pm(pm)
332 register PMOP *pm;
333 {
334     char ch;
335
336     if (!pm) {
337         dump("{}\n");
338         return;
339     }
340     dump("{\n");
341     dumplvl++;
342     if (pm->op_pmflags & PMf_ONCE)
343         ch = '?';
344     else
345         ch = '/';
346     if (pm->op_pmregexp)
347         dump("PMf_PRE %c%s%c\n",ch,pm->op_pmregexp->precomp,ch);
348     if (pm->op_type != OP_PUSHRE && pm->op_pmreplroot) {
349         dump("PMf_REPL = ");
350         dump_op(pm->op_pmreplroot);
351     }
352     if (pm->op_pmshort) {
353         dump("PMf_SHORT = %s\n",SvPEEK(pm->op_pmshort));
354     }
355     if (pm->op_pmflags) {
356         *buf = '\0';
357         if (pm->op_pmflags & PMf_USED)
358             (void)strcat(buf,"USED,");
359         if (pm->op_pmflags & PMf_ONCE)
360             (void)strcat(buf,"ONCE,");
361         if (pm->op_pmflags & PMf_SCANFIRST)
362             (void)strcat(buf,"SCANFIRST,");
363         if (pm->op_pmflags & PMf_ALL)
364             (void)strcat(buf,"ALL,");
365         if (pm->op_pmflags & PMf_SKIPWHITE)
366             (void)strcat(buf,"SKIPWHITE,");
367         if (pm->op_pmflags & PMf_CONST)
368             (void)strcat(buf,"CONST,");
369         if (pm->op_pmflags & PMf_KEEP)
370             (void)strcat(buf,"KEEP,");
371         if (pm->op_pmflags & PMf_GLOBAL)
372             (void)strcat(buf,"GLOBAL,");
373         if (pm->op_pmflags & PMf_RUNTIME)
374             (void)strcat(buf,"RUNTIME,");
375         if (pm->op_pmflags & PMf_EVAL)
376             (void)strcat(buf,"EVAL,");
377         if (*buf)
378             buf[strlen(buf)-1] = '\0';
379         dump("PMFLAGS = (%s)\n",buf);
380     }
381
382     dumplvl--;
383     dump("}\n");
384 }
385
386
387 #if !defined(I_STDARG) && !defined(I_VARARGS)
388 /* VARARGS1 */
389 static void dump(arg1,arg2,arg3,arg4,arg5)
390 char *arg1;
391 long arg2, arg3, arg4, arg5;
392 {
393     I32 i;
394
395     for (i = dumplvl*4; i; i--)
396         (void)PerlIO_putc(Perl_debug_log,' ');
397     PerlIO_printf(Perl_debug_log, arg1, arg2, arg3, arg4, arg5);
398 }
399
400 #else
401
402 #ifdef I_STDARG
403 static void
404 dump(char *pat,...)
405 #else
406 /*VARARGS0*/
407 static void
408 dump(pat,va_alist)
409     char *pat;
410     va_dcl
411 #endif
412 {
413     I32 i;
414     va_list args;
415
416 #ifdef I_STDARG
417     va_start(args, pat);
418 #else
419     va_start(args);
420 #endif
421     for (i = dumplvl*4; i; i--)
422         (void)PerlIO_putc(Perl_debug_log,' ');
423     PerlIO_vprintf(Perl_debug_log,pat,args);
424     va_end(args);
425 }
426 #endif
427
428 #endif