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