Devel::Peek: Indentation gap when dumping MG object #16380
Comments
From @KES777Created by @KES777Depending on the PL_dumpindent the MG_OBJ details are dumped with indentation gap: Look at output: PL_dumpindent = 1; PL_dumpindent = 2; PL_dumpindent = 3; So this is unclear where SV belons to There is no any documentation about PL_dumpindent Perl Info |
From @KES777Another example of ambiguity: Here we can think that PADNAME is member of PVCV. But from the next out we can understand that PADNAME is child for PADLIST: |
From @KES777Also there are different defaults for PL_dumpindent when dumping from perl script and from XS |
From @jkeenanOn Thu, 25 Jan 2018 11:16:40 GMT, kes-kes@yandex.ru wrote:
Would you be able to provide a short program which a programmer not fluent in XS could run in order to become familiar with this problem. (It's not clear what you did to generate the sample above.)
Confirmed -- but if it's an implementation detail internal to Peek.xs we probably don't want to formally document it. The POD in Peek.pm takes a very cautious approach: 'This document will take a passive, and safe, approach to data debugging and for that it will describe only the "Dump()" function.' Thank you very much. -- |
|
The RT System itself - Status changed from 'new' to 'open' |
From @KES777The Devel::Peek makes use of undocumented perlapi function: do_sv_dump https://metacpan.org/source/XSAWYERX/perl-5.28.0/ext/Devel-Peek/Peek.xs#L337 The issue is about formatting: PADLIST = 0x2774220 VS PADLIST = 0x2774220 From the output I can not say that PADNAME is member of PADLIST See an example: https://metacpan.org/pod/Devel::Peek#A-reference-to-a-subroutine This undocumented function has configuration for the indentation. |
From @jkeenanOn Tue, 04 Sep 2018 08:09:34 GMT, kes-kes@yandex.ru wrote:
Please find attached a small program, '132764-devel-peek.pl', which Dump-s a reference to a subroutine using a sub name drawn from the Devel::Peek documentation. When I run it (perl-5.28.0), I get the output attached as '132764.top_targets.output.txt'. How would I re-write sub MY::top_targets to make it complicated enough to display the ambiguous indentation you just described? Thank you very much. |
From @jkeenanSV = IV(0x25e0568) at 0x25e0578 |
From @KES777
Actually your dump is already ambigious: PADNAME is a member of PADLIST, not the `SV = PVCV(0x25fd4b8) at 0x2606fb0` Play with this value: PL_dumpindent = 3; I change your script and attach the XS |
From @tonycozOn Tue, 04 Sep 2018 08:01:39 -0700, jkeenan wrote:
The attached patch against blead might make this easier to demonstrate. $ ./perl -Ilib -MDevel::Peek -e '$Devel::Peek::dumpindent = 2; Dump(\$!)' Tony |
From @tonycoz0001-perl-132764-provide-control-over-Dump-s-indent-level.patchFrom f4e7b27e04a51b46154f733b7e06c8c7f9d1bfe6 Mon Sep 17 00:00:00 2001
From: Tony Cook <tony@develop-help.com>
Date: Thu, 6 Sep 2018 10:32:52 +1000
Subject: (perl #132764) provide control over Dump()s indent level
Mostly intended for easily demonstrating the issue in #132764.
Needs tests/docs before it's merged to blead.
---
ext/Devel-Peek/Peek.pm | 2 ++
ext/Devel-Peek/Peek.xs | 6 ++++--
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/ext/Devel-Peek/Peek.pm b/ext/Devel-Peek/Peek.pm
index 3d790e763a..0c9499b44e 100644
--- a/ext/Devel-Peek/Peek.pm
+++ b/ext/Devel-Peek/Peek.pm
@@ -18,6 +18,8 @@ require XSLoader;
XSLoader::load();
+our $dump_indent = 2;
+
sub import {
my $c = shift;
my $ops_rx = qr/^:opd(=[stP]*)?\b/;
diff --git a/ext/Devel-Peek/Peek.xs b/ext/Devel-Peek/Peek.xs
index 8a8c0b96d7..9550ca4a8e 100644
--- a/ext/Devel-Peek/Peek.xs
+++ b/ext/Devel-Peek/Peek.xs
@@ -333,7 +333,8 @@ S_do_dump(pTHX_ SV *const sv, I32 lim)
const STRLEN pv_lim = pv_lim_sv ? SvIV(pv_lim_sv) : 0;
SV *dumpop = perl_get_sv("Devel::Peek::dump_ops", 0);
const U16 save_dumpindent = PL_dumpindent;
- PL_dumpindent = 2;
+ SV *dumpindent_sv = perl_get_sv("Devel::Peek::dumpindent", 0);
+ PL_dumpindent = dumpindent_sv ? SvIV(dumpindent_sv) : 2;
do_sv_dump(0, Perl_debug_log, sv, 0, lim,
(bool)(dumpop && SvTRUE(dumpop)), pv_lim);
PL_dumpindent = save_dumpindent;
@@ -458,7 +459,8 @@ PPCODE:
const STRLEN pv_lim = pv_lim_sv ? SvIV(pv_lim_sv) : 0;
SV *dumpop = perl_get_sv("Devel::Peek::dump_ops", 0);
const U16 save_dumpindent = PL_dumpindent;
- PL_dumpindent = 2;
+ SV *dumpindent_sv = perl_get_sv("Devel::Peek::dumpindent", 0);
+ PL_dumpindent = dumpindent_sv ? SvIV(dumpindent_sv) : 2;
for (i=1; i<items; i++) {
PerlIO_printf(Perl_debug_log, "Elt No. %ld 0x%" UVxf "\n", i - 1, PTR2UV(ST(i)));
--
2.11.0
|
Migrated from rt.perl.org#132764 (status was 'open')
Searchable as RT132764$
The text was updated successfully, but these errors were encountered: