File: Dumper.html

package info (click to toggle)
data-dumper 2.07-1
links: PTS
area: main
in suites: hamm
size: 156 kB
ctags: 49
sloc: perl: 570; makefile: 37; sh: 16
file content (505 lines) | stat: -rw-r--r-- 17,269 bytes
<!-- $Id$ -->
<HTML><HEAD>
<CENTER><TITLE>Dumper</TITLE>
</HEAD>
<BODY></CENTER><p><hr>

<H1> 
<A NAME="Dumper_name_0">
NAME</A>
</H1>
Data::Dumper - stringified perl data structures, suitable for both printing and <CODE>eval</CODE>
<p><p><hr>

<H1> 
<A NAME="Dumper_synopsis_0">
SYNOPSIS</A>
</H1>

<XMP>
    use Data::Dumper;
    # simple procedural interface
    print Dumper($foo, $bar);
    # extended usage with names
    print Data::Dumper->Dump([$foo, $bar], [qw(foo *ary)]);
    # configuration variables
    {
      local $Data::Dump::Purity = 1;
      eval Data::Dumper->Dump([$foo, $bar], [qw(foo *ary)]);
    }
    # OO usage
    $d = Data::Dumper->new([$foo, $bar], [qw(foo *ary)]);
       ...
    print $d->Dump;
       ...
    $d->Purity(1);
    $d->Terse(1);
    $d->Deepcopy(1);
    eval $d->Dump;

</XMP>
<p><p><hr>

<H1> 
<A NAME="Dumper_description_0">
DESCRIPTION</A>
</H1>
Given a list of scalars or reference variables, writes out their contents in
perl syntax. The references can also be objects.  The contents of each
variable is output in a single Perl statement.
<p>The return value can be <CODE>eval</CODE>ed to get back the original reference
structure. Bear in mind that a reference so created will not preserve
pointer equalities with the original reference.
<p>Handles self-referential structures correctly.  Any references that are the
same as one of those passed in will be marked <CODE><STRONG>$VAR</STRONG></CODE><EM>n</EM> (where <EM>n</EM> is a
numeric suffix), and other duplicate references to substructures within 
<CODE><STRONG>$VAR</STRONG></CODE><EM>n</EM> will be appropriately labeled using arrow notation.  You can
specify names for individual values to be dumped if you use the <CODE><EM>Dump()</EM></CODE>
method, or you can change the default <CODE><STRONG>$VAR</STRONG></CODE> prefix to something else.  See
<EM>
<A HREF="Dumper.html#Dumper_data_dumper_varname_0">$Data::Dumper::Varname</A>
</EM> and <EM>
<A HREF="Dumper.html#Dumper_data_dumper_terse_0">$Data::Dumper::Terse</A>
</EM> below.
<p>The default output of self-referential structures can be <CODE>eval</CODE>ed, but the
nested references to <CODE><STRONG>$VAR</STRONG></CODE><EM>n</EM> will be undefined, since a recursive
structure cannot be constructed using one Perl statement.  You can set the
<CODE>Purity</CODE> flag to 1 to get additional statements that will correctly fill in
these references.
<p>In the extended usage form, the references to be dumped can be given
user-specified names.  If a name begins with a <CODE>*</CODE>, the output will 
describe the dereferenced type of the supplied reference for hashes and
arrays.  Output of names will be avoided where possible if the <CODE>Terse</CODE>
flag is set.
<p>Several styles of output are possible, all controlled by setting
the <CODE>Indent</CODE> flag.  See 
<A HREF="Dumper.html#Dumper_configuration_0"><EM>Configuration Variables or Methods</EM></A>
 below 
for details.
<p>
<H2> 
<A NAME="Dumper_methods_0">
Methods</A>
</H2>
<p>
<DL COMPACT>
<DT><STRONG>
<EM>PACKAGE</EM>-&gt;new(<EM>ARRAYREF [</EM>, <EM>ARRAYREF]</EM>)
</STRONG>
<DD>
Returns a newly created <CODE>Data::Dumper</CODE> object.  The first argument is an
anonymous array of values to be dumped.  The optional second argument is an
anonymous array of names for the values.  The names need not have a leading
<CODE>$</CODE> sign, and must be comprised of alphanumeric characters.  You can begin
a name with a <CODE>*</CODE> to specify that the dereferenced type must be dumped
instead of the reference itself, for ARRAY and HASH references.
<p>The prefix specified by 
<A HREF="Dumper.html#Dumper_data_dumper_varname_0">
<A HREF="Dumper.html#Dumper_data_dumper_varname_0">$Data::Dumper::Varname</A>
</A>
 will be used with a
numeric suffix if the name for a value is undefined.
<p>Data::Dumper will catalog all references encountered while dumping the
values. Cross-references (in the form of names of substructures in perl
syntax) will be inserted at all possible points, preserving any structural
interdependencies in the original set of values.  Structure traversal is
depth-first,  and proceeds in order from the first supplied value to
the last.
<p>
<DT><STRONG>
<EM><STRONG>$OBJ</STRONG></EM>-&gt;Dump  <EM>or</EM>  <EM>PACKAGE</EM>-&gt;Dump(<EM>ARRAYREF [</EM>, <EM>ARRAYREF]</EM>)
</STRONG>
<DD>
Returns the stringified form of the values stored in the object (preserving
the order in which they were supplied to <CODE>new</CODE>), subject to the
configuration options below.  In an array context, it returns a list
of strings corresponding to the supplied values.
<p>The second form, for convenience, simply calls the <CODE>new</CODE> method on its
arguments before dumping the object immediately.
<p>
<DT><STRONG>
<EM><STRONG>$OBJ</STRONG></EM>-&gt;Dumpxs  <EM>or</EM>  <EM>PACKAGE</EM>-&gt;Dumpxs(<EM>ARRAYREF [</EM>, <EM>ARRAYREF]</EM>)
</STRONG>
<DD>
This method is available if you were able to compile and install the XSUB
extension to <CODE>Data::Dumper</CODE>. It is exactly identical to the <CODE>Dump</CODE> method 
above, only about 4 to 5 times faster, since it is written entirely in C.
<p>
<DT><STRONG>
<EM><STRONG>$OBJ</STRONG></EM>-&gt;Seen(<EM>[HASHREF]</EM>)
</STRONG>
<DD>
Queries or adds to the internal table of already encountered references.
You must use <CODE>Reset</CODE> to explicitly clear the table if needed.  Such
references are not dumped; instead, their names are inserted wherever they
are encountered subsequently.
<p>Expects a anonymous hash of name =&gt; value pairs.  Same rules apply for names
as in <CODE>new</CODE>.  If no argument is supplied, will return the ``seen'' list of
name =&gt; value pairs, in an array context.
<p>
<DT><STRONG>
<EM><STRONG>$OBJ</STRONG></EM>-&gt;Values(<EM>[ARRAYREF]</EM>)
</STRONG>
<DD>
Queries or replaces the internal array of values that will be dumped.
<p>
<DT><STRONG>
<EM><STRONG>$OBJ</STRONG></EM>-&gt;Names(<EM>[ARRAYREF]</EM>)
</STRONG>
<DD>
Queries or replaces the internal array of user supplied names for the values
that will be dumped.
<p>
<DT><STRONG>
<EM><STRONG>$OBJ</STRONG></EM>-&gt;Reset
</STRONG>
<DD>
Clears the internal table of ``seen'' references.
<p>
</DL>

<H2> 
<A NAME="Dumper_functions_0">
Functions</A>
</H2>
<p>
<DL COMPACT>
<DT><STRONG>
Dumper(<EM>LIST</EM>)
</STRONG>
<DD>
Returns the stringified form of the values in the list, subject to the
configuration options below.  The values will be named <CODE><STRONG>$VAR</STRONG></CODE><EM>n</EM> in the
output, where <EM>n</EM> is a numeric suffix.  Will return a list of strings
in an array context.
<p>
<DT><STRONG>
DumperX(<EM>LIST</EM>)
</STRONG>
<DD>
Identical to the 
<A HREF="Dumper.html#Dumper_dumper_0">
<A HREF="Dumper.html#Dumper_dumper_0">Dumper()</A>
</A>
 function above, but this calls the XSUB 
implementation.  Only available if you were able to compile and install
the XSUB extensions in <CODE>Data::Dumper</CODE>.
<p>
</DL>

<H2> 
<A NAME="Dumper_configuration_0">
Configuration Variables or Methods</A>
</H2>
Several configuration variables can be used to control the kind of output
generated when using the procedural interface.  These variables are usually
<CODE>local</CODE>ized in a block so that other parts of the code are not affected by
the change.  
<p>These variables determine the default state of the object created by calling
the <CODE>new</CODE> method, but cannot be used to alter the state of the object
thereafter.  The equivalent method names should be used instead to query
or set the internal state of the object.
<p>
<DL COMPACT>
<DT><STRONG>

<A NAME="Dumper_data_dumper_indent_0">
$Data::Dumper::Indent</A>
  <EM>or</EM>  <EM><STRONG>$OBJ</STRONG></EM>-&gt;Indent(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
Controls the style of indentation.  It can be set to 0, 1, 2 or 3.  Style 0
spews output without any newlines, indentation, or spaces between list
items.  It is the most compact format possible that can still be called
valid perl.  Style 1 outputs a readable form with newlines but no fancy
indentation (each level in the structure is simply indented by a fixed
amount of whitespace).  Style 2 (the default) outputs a very readable form
which takes into account the length of hash keys (so the hash value lines
up).  Style 3 is like style 2, but also annotates the elements of arrays
with their index (but the comment is on its own line, so array output
consumes twice the number of lines).  Style 2 is the default.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_purity_0">
$Data::Dumper::Purity</A>
  <EM>or</EM>  <EM><STRONG>$OBJ</STRONG></EM>-&gt;Purity(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
Controls the degree to which the output can be <CODE>eval</CODE>ed to recreate the
supplied reference structures.  Setting it to 1 will output additional perl
statements that will correctly recreate nested references.  The default is
0.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_pad_0">
$Data::Dumper::Pad</A>
  <EM>or</EM>  <EM><STRONG>$OBJ</STRONG></EM>-&gt;Pad(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
Specifies the string that will be prefixed to every line of the output.
Empty string by default.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_varname_0">
$Data::Dumper::Varname</A>
  <EM>or</EM>  <EM><STRONG>$OBJ</STRONG></EM>-&gt;Varname(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
Contains the prefix to use for tagging variable names in the output. The
default is ``VAR''.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_useqq_0">
$Data::Dumper::Useqq</A>
  <EM>or</EM>  <EM><STRONG>$OBJ</STRONG></EM>-&gt;Useqq(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
When set, enables the use of double quotes for representing string values.
Whitespace other than space will be represented as <CODE>[\n\t\r]</CODE>, ``unsafe''
characters will be backslashed, and unprintable characters will be output as
quoted octal integers.  Since setting this variable imposes a performance
penalty, the default is 0.  The <CODE><EM>Dumpxs()</EM></CODE> method does not honor this
flag yet.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_terse_0">
$Data::Dumper::Terse</A>
  <EM>or</EM>  <EM><STRONG>$OBJ</STRONG></EM>-&gt;Terse(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
When set, Data::Dumper will emit single, non-self-referential values as
atoms/terms rather than statements.  This means that the <CODE><STRONG>$VAR</STRONG></CODE><EM>n</EM> names
will be avoided where possible, but be advised that such output may not
always be parseable by <CODE>eval</CODE>.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_freezer_0">
$Data::Dumper::Freezer</A>
  <EM>or</EM>  <STRONG>$<</STRONG>EM>OBJ</EM>-&gt;Freezer(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
Can be set to a method name, or to an empty string to disable the feature.
Data::Dumper will invoke that method via the object before attempting to
stringify it.  This method can alter the contents of the object (if, for
instance, it contains data allocated from C), and even rebless it in a
different package.  The client is responsible for making sure the specified
method can be called via the object, and that the object ends up containing
only perl data types after the method has been called.  Defaults to an empty
string.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_toaster_0">
$Data::Dumper::Toaster</A>
  <EM>or</EM>  <STRONG>$<</STRONG>EM>OBJ</EM>-&gt;Toaster(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
Can be set to a method name, or to an empty string to disable the feature.
Data::Dumper will emit a method call for any objects that are to be dumped
using the syntax <CODE>bless(DATA, CLASS)-</CODE><EM>METHOD()</EM>&gt;.  Note that this means that
the method specified will have to perform any modifications required on the
object (like creating new state within it, and/or reblessing it in a
different package) and then return it.  The client is responsible for making
sure the method can be called via the object, and that it returns a valid
object.  Defaults to an empty string.
<p>
<DT><STRONG>

<A NAME="Dumper_data_dumper_deepcopy_0">
$Data::Dumper::Deepcopy</A>
  <EM>or</EM>  <STRONG>$<</STRONG>EM>OBJ</EM>-&gt;Deepcopy(<EM>[NEWVAL]</EM>)
</STRONG>
<DD>
Can be set to a boolean value to enable deep copies of structures.
Cross-referencing will then only be done when absolutely essential
(i.e., to break reference cycles).  Default is 0.
<p>
</DL>

<H2> 
<A NAME="Dumper_exports_0">
Exports</A>
</H2>
<p>
<DL COMPACT>
<DT><STRONG>

<A NAME="Dumper_dumper_0">
Dumper</A>

</STRONG>
<DD>
<p><hr>

<H1> 
<A NAME="Dumper_example_0">
EXAMPLE</A>
</H1>
Run these code snippets to get a quick feel for the behavior of this
module.  When you are through with these examples, you may want to
add or change the various configuration variables described above,
to see their behavior.  (See the testsuite in the Data::Dumper
distribution for more examples.)
<p>
<XMP>
    use Data::Dumper;
    package Foo;
    sub new {bless {'a' => 1, 'b' => sub { return "foo" }}, $_[0]};
    package Fuz;                       # a weird REF-REF-SCALAR object
    sub new {bless \($_ = \ 'fu\'z'), $_[0]};
    package main;
    $foo = Foo->new;
    $fuz = Fuz->new;
    $boo = [ 1, [], "abcd", \*foo,
             {1 => 'a', 023 => 'b', 0x45 => 'c'}, 
             \\"p\q\'r", $foo, $fuz];
    
    ########
    # simple usage
    ########
    $bar = eval(Dumper($boo));
    print($@) if $@;
    print Dumper($boo), Dumper($bar);  # pretty print (no array indices)
    $Data::Dumper::Terse = 1;          # don't output names where feasible
    $Data::Dumper::Indent = 0;         # turn off all pretty print
    print Dumper($boo), "\n";
    $Data::Dumper::Indent = 1;         # mild pretty print
    print Dumper($boo);
    $Data::Dumper::Indent = 3;         # pretty print with array indices
    print Dumper($boo);
    $Data::Dumper::Useqq = 1;          # print strings in double quotes
    print Dumper($boo);
    
    
    ########
    # recursive structures
    ########
    
    
    @c = ('c');
    $c = \@c;
    $b = {};
    $a = [1, $b, $c];
    $b->{a} = $a;
    $b->{b} = $a->[1];
    $b->{c} = $a->[2];
    print Data::Dumper->Dump([$a,$b,$c], [qw(a b c)]);
    
    
    $Data::Dumper::Purity = 1;         # fill in the holes for eval
    print Data::Dumper->Dump([$a, $b], [qw(*a b)]); # print as @a
    print Data::Dumper->Dump([$b, $a], [qw(*b a)]); # print as %b
    
    
    $Data::Dumper::Deepcopy = 1;       # avoid cross-refs
    print Data::Dumper->Dump([$b, $a], [qw(*b a)]);
    
    
    $Data::Dumper::Purity = 0;         # avoid cross-refs
    print Data::Dumper->Dump([$b, $a], [qw(*b a)]);
    
    
    ########
    # object-oriented usage
    ########
    
    
    $d = Data::Dumper->new([$a,$b], [qw(a b)]);
    $d->Seen({'*c' => $c});            # stash a ref without printing it
    $d->Indent(3);
    print $d->Dump;
    $d->Reset;                         # empty the seen cache
    $d->Purity(0);
    print join "----\n", $d->Dump;
    
    
    ########
    # persistence
    ########
    
    
    package Foo;
    sub new { bless { state => 'awake' }, shift }
    sub Freeze {
        my $s = shift;
        print STDERR "preparing to sleep\n";
        $s->{state} = 'asleep';
        return bless $s, 'Foo::ZZZ';
    }
    
    package Foo::ZZZ;
    sub Thaw {
        my $s = shift;
        print STDERR "waking up\n";
        $s->{state} = 'awake';
        return bless $s, 'Foo';
    }
    
    package Foo;
    use Data::Dumper;
    my $a = Foo->new;
    my $b = Data::Dumper->new([$a], ['c']);
    $b->Freezer('Freeze');
    $b->Toaster('Thaw');
    my $c = $b->Dump;
    print $c;
    my $d = eval $c;
    print Data::Dumper->Dump([$d], ['d']);

</XMP>
<p><p><hr>

<H1> 
<A NAME="Dumper_bugs_0">
BUGS</A>
</H1>
Due to limitations of Perl subroutine call semantics, you cannot pass an
array or hash.  Prepend it with a <CODE>\</CODE> to pass its reference instead.  This
will be remedied in time, with the arrival of prototypes in later versions
of Perl.  For now, you need to use the extended usage form, and prepend the
name with a <CODE>*</CODE> to output it as a hash or array.
<p><CODE>Data::Dumper</CODE> cheats with CODE references.  If a code reference is
encountered in the structure being processed, an anonymous subroutine that
contains the string '``DUMMY''' will be inserted in its place, and a warning
will be printed if <CODE>Purity</CODE> is set.  You can <CODE>eval</CODE> the result, but bear
in mind that the anonymous sub that gets created is just a placeholder.
Someday, perl will have a switch to cache-on-demand the string
representation of a compiled piece of code, I hope.
<p>The <CODE>Useqq</CODE> flag is not honored by <CODE><EM>Dumpxs()</EM></CODE> (it always outputs
strings in single quotes).
<p>SCALAR objects have the weirdest looking <CODE>bless</CODE> workaround.
<p><p><hr>

<H1> 
<A NAME="Dumper_author_0">
AUTHOR</A>
</H1>
Gurusamy Sarathy        <A HREF="MAILTO:gsar@umich.edu">gsar@umich.edu</A>
<p>Copyright (c) 1996 Gurusamy Sarathy. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
<p><p><hr>

<H1> 
<A NAME="Dumper_version_0">
VERSION</A>
</H1>
Version 2.07    (7 December 1996)
<p><p><hr>

<H1> 
<A NAME="Dumper_see_0">
SEE ALSO</A>
</H1>
perl(1)
<p>
</DL>

</BODY>
</HTML>