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