Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Data::Dumper.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Data::Dumper 3"
.TH Data::Dumper 3 "2002-06-01" "perl v5.8.0" "Perl Programmers Reference Guide"
.SH "NAME"
Data::Dumper \- stringified perl data structures, suitable for both printing and \f(CW\*(C`eval\*(C'\fR
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Data::Dumper;
.Ve
.PP
.Vb 2
\&    # simple procedural interface
\&    print Dumper($foo, $bar);
.Ve
.PP
.Vb 2
\&    # extended usage with names
\&    print Data::Dumper->Dump([$foo, $bar], [qw(foo *ary)]);
.Ve
.PP
.Vb 5
\&    # configuration variables
\&    {
\&      local $Data::Dump::Purity = 1;
\&      eval Data::Dumper->Dump([$foo, $bar], [qw(foo *ary)]);
\&    }
.Ve
.PP
.Vb 7
\&    # OO usage
\&    $d = Data::Dumper->new([$foo, $bar], [qw(foo *ary)]);
\&       ...
\&    print $d->Dump;
\&       ...
\&    $d->Purity(1)->Terse(1)->Deepcopy(1);
\&    eval $d->Dump;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
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.  Handles self-referential
structures correctly.
.PP
The return value can be \f(CW\*(C`eval\*(C'\fRed to get back an identical copy of the
original reference structure.
.PP
Any references that are the same as one of those passed in will be named
\&\f(CW$VAR\fR\fIn\fR (where \fIn\fR is a numeric suffix), and other duplicate references
to substructures within \f(CW$VAR\fR\fIn\fR will be appropriately labeled using arrow
notation.  You can specify names for individual values to be dumped if you
use the \f(CW\*(C`Dump()\*(C'\fR method, or you can change the default \f(CW$VAR\fR prefix to
something else.  See \f(CW$Data::Dumper::Varname\fR and \f(CW$Data::Dumper::Terse\fR
below.
.PP
The default output of self-referential structures can be \f(CW\*(C`eval\*(C'\fRed, but the
nested references to \f(CW$VAR\fR\fIn\fR will be undefined, since a recursive
structure cannot be constructed using one Perl statement.  You should set the
\&\f(CW\*(C`Purity\*(C'\fR flag to 1 to get additional statements that will correctly fill in
these references.
.PP
In the extended usage form, the references to be dumped can be given
user-specified names.  If a name begins with a \f(CW\*(C`*\*(C'\fR, the output will 
describe the dereferenced type of the supplied reference for hashes and
arrays, and coderefs.  Output of names will be avoided where possible if
the \f(CW\*(C`Terse\*(C'\fR flag is set.
.PP
In many cases, methods that are used to set the internal state of the
object will return the object itself, so method calls can be conveniently
chained together.
.PP
Several styles of output are possible, all controlled by setting
the \f(CW\*(C`Indent\*(C'\fR flag.  See \*(L"Configuration Variables or Methods\*(R" below 
for details.
.Sh "Methods"
.IX Subsection "Methods"
.IP "\fI\s-1PACKAGE\s0\fR\->new(\fI\s-1ARRAYREF\s0 [\fR, \fI\s-1ARRAYREF\s0]\fR)" 4
.IX Item "PACKAGE->new(ARRAYREF [, ARRAYREF])"
Returns a newly created \f(CW\*(C`Data::Dumper\*(C'\fR 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
\&\f(CW\*(C`$\*(C'\fR sign, and must be comprised of alphanumeric characters.  You can begin
a name with a \f(CW\*(C`*\*(C'\fR to specify that the dereferenced type must be dumped
instead of the reference itself, for \s-1ARRAY\s0 and \s-1HASH\s0 references.
.Sp
The prefix specified by \f(CW$Data::Dumper::Varname\fR will be used with a
numeric suffix if the name for a value is undefined.
.Sp
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.
.IP "\fI$OBJ\fR\->Dump  \fIor\fR  \fI\s-1PACKAGE\s0\fR\->Dump(\fI\s-1ARRAYREF\s0 [\fR, \fI\s-1ARRAYREF\s0]\fR)" 4
.IX Item "$OBJ->Dump  or  PACKAGE->Dump(ARRAYREF [, ARRAYREF])"
Returns the stringified form of the values stored in the object (preserving
the order in which they were supplied to \f(CW\*(C`new\*(C'\fR), subject to the
configuration options below.  In a list context, it returns a list
of strings corresponding to the supplied values.
.Sp
The second form, for convenience, simply calls the \f(CW\*(C`new\*(C'\fR method on its
arguments before dumping the object immediately.
.IP "\fI$OBJ\fR\->Seen(\fI[\s-1HASHREF\s0]\fR)" 4
.IX Item "$OBJ->Seen([HASHREF])"
Queries or adds to the internal table of already encountered references.
You must use \f(CW\*(C`Reset\*(C'\fR to explicitly clear the table if needed.  Such
references are not dumped; instead, their names are inserted wherever they
are encountered subsequently.  This is useful especially for properly
dumping subroutine references.
.Sp
Expects an anonymous hash of name => value pairs.  Same rules apply for names
as in \f(CW\*(C`new\*(C'\fR.  If no argument is supplied, will return the \*(L"seen\*(R" list of
name => value pairs, in a list context.  Otherwise, returns the object
itself.
.IP "\fI$OBJ\fR\->Values(\fI[\s-1ARRAYREF\s0]\fR)" 4
.IX Item "$OBJ->Values([ARRAYREF])"
Queries or replaces the internal array of values that will be dumped.
When called without arguments, returns the values.  Otherwise, returns the
object itself.
.IP "\fI$OBJ\fR\->Names(\fI[\s-1ARRAYREF\s0]\fR)" 4
.IX Item "$OBJ->Names([ARRAYREF])"
Queries or replaces the internal array of user supplied names for the values
that will be dumped.  When called without arguments, returns the names.
Otherwise, returns the object itself.
.IP "\fI$OBJ\fR\->Reset" 4
.IX Item "$OBJ->Reset"
Clears the internal table of \*(L"seen\*(R" references and returns the object
itself.
.Sh "Functions"
.IX Subsection "Functions"
.IP "Dumper(\fI\s-1LIST\s0\fR)" 4
.IX Item "Dumper(LIST)"
Returns the stringified form of the values in the list, subject to the
configuration options below.  The values will be named \f(CW$VAR\fR\fIn\fR in the
output, where \fIn\fR is a numeric suffix.  Will return a list of strings
in a list context.
.Sh "Configuration Variables or Methods"
.IX Subsection "Configuration Variables or Methods"
Several configuration variables can be used to control the kind of output
generated when using the procedural interface.  These variables are usually
\&\f(CW\*(C`local\*(C'\fRized in a block so that other parts of the code are not affected by
the change.  
.PP
These variables determine the default state of the object created by calling
the \f(CW\*(C`new\*(C'\fR 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.
.PP
The method forms return the object itself when called with arguments,
so that they can be chained together nicely.
.IP "$Data::Dumper::Indent  \fIor\fR  \fI$OBJ\fR\->Indent(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Indent  or  $OBJ->Indent([NEWVAL])"
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.
.IP "$Data::Dumper::Purity  \fIor\fR  \fI$OBJ\fR\->Purity(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Purity  or  $OBJ->Purity([NEWVAL])"
Controls the degree to which the output can be \f(CW\*(C`eval\*(C'\fRed 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.
.IP "$Data::Dumper::Pad  \fIor\fR  \fI$OBJ\fR\->Pad(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Pad  or  $OBJ->Pad([NEWVAL])"
Specifies the string that will be prefixed to every line of the output.
Empty string by default.
.IP "$Data::Dumper::Varname  \fIor\fR  \fI$OBJ\fR\->Varname(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Varname  or  $OBJ->Varname([NEWVAL])"
Contains the prefix to use for tagging variable names in the output. The
default is \*(L"\s-1VAR\s0\*(R".
.IP "$Data::Dumper::Useqq  \fIor\fR  \fI$OBJ\fR\->Useqq(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Useqq  or  $OBJ->Useqq([NEWVAL])"
When set, enables the use of double quotes for representing string values.
Whitespace other than space will be represented as \f(CW\*(C`[\en\et\er]\*(C'\fR, \*(L"unsafe\*(R"
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.  \f(CW\*(C`Dump()\*(C'\fR will run slower if this flag is set,
since the fast \s-1XSUB\s0 implementation doesn't support it yet.
.IP "$Data::Dumper::Terse  \fIor\fR  \fI$OBJ\fR\->Terse(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Terse  or  $OBJ->Terse([NEWVAL])"
When set, Data::Dumper will emit single, non-self-referential values as
atoms/terms rather than statements.  This means that the \f(CW$VAR\fR\fIn\fR names
will be avoided where possible, but be advised that such output may not
always be parseable by \f(CW\*(C`eval\*(C'\fR.
.IP "$Data::Dumper::Freezer  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Freezer(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Freezer  or  $OBJ->Freezer([NEWVAL])"
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.
.IP "$Data::Dumper::Toaster  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Toaster(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Toaster  or  $OBJ->Toaster([NEWVAL])"
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 \f(CW\*(C`bless(DATA, CLASS)\->METHOD()\*(C'\fR.  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.
.IP "$Data::Dumper::Deepcopy  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Deepcopy(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Deepcopy  or  $OBJ->Deepcopy([NEWVAL])"
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.
.IP "$Data::Dumper::Quotekeys  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Quotekeys(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Quotekeys  or  $OBJ->Quotekeys([NEWVAL])"
Can be set to a boolean value to control whether hash keys are quoted.
A false value will avoid quoting hash keys when it looks like a simple
string.  Default is 1, which will always enclose hash keys in quotes.
.IP "$Data::Dumper::Bless  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Bless(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Bless  or  $OBJ->Bless([NEWVAL])"
Can be set to a string that specifies an alternative to the \f(CW\*(C`bless\*(C'\fR
builtin operator used to create objects.  A function with the specified
name should exist, and should accept the same arguments as the builtin.
Default is \f(CW\*(C`bless\*(C'\fR.
.IP "$Data::Dumper::Maxdepth  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Maxdepth(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Maxdepth  or  $OBJ->Maxdepth([NEWVAL])"
Can be set to a positive integer that specifies the depth beyond which
which we don't venture into a structure.  Has no effect when
\&\f(CW\*(C`Data::Dumper::Purity\*(C'\fR is set.  (Useful in debugger when we often don't
want to see more than enough).  Default is 0, which means there is 
no maximum depth. 
.IP "$Data::Dumper::Useperl  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Useperl(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Useperl  or  $OBJ->Useperl([NEWVAL])"
Can be set to a boolean value which controls whether the pure Perl
implementation of \f(CW\*(C`Data::Dumper\*(C'\fR is used. The \f(CW\*(C`Data::Dumper\*(C'\fR module is
a dual implementation, with almost all functionality written in both
pure Perl and also in \s-1XS\s0 ('C'). Since the \s-1XS\s0 version is much faster, it
will always be used if possible. This option lets you override the
default behavior, usually for testing purposes only. Default is 0, which
means the \s-1XS\s0 implementation will be used if possible.
.IP "$Data::Dumper::Sortkeys  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Sortkeys(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Sortkeys  or  $OBJ->Sortkeys([NEWVAL])"
Can be set to a boolean value to control whether hash keys are dumped in
sorted order. A true value will cause the keys of all hashes to be
dumped in Perl's default sort order. Can also be set to a subroutine
reference which will be called for each hash that is dumped. In this
case \f(CW\*(C`Data::Dumper\*(C'\fR will call the subroutine once for each hash,
passing it the reference of the hash. The purpose of the subroutine is
to return a reference to an array of the keys that will be dumped, in
the order that they should be dumped. Using this feature, you can
control both the order of the keys, and which keys are actually used. In
other words, this subroutine acts as a filter by which you can exclude
certain keys from being dumped. Default is 0, which means that hash keys
are not sorted.
.IP "$Data::Dumper::Deparse  \fIor\fR  $\fI\s-1OBJ\s0\fR\->Deparse(\fI[\s-1NEWVAL\s0]\fR)" 4
.IX Item "$Data::Dumper::Deparse  or  $OBJ->Deparse([NEWVAL])"
Can be set to a boolean value to control whether code references are
turned into perl source code. If set to a true value, \f(CW\*(C`B::Deparse\*(C'\fR
will be used to get the source of the code reference. Using this option
will force using the Perl implementation of the dumper, since the fast
\&\s-1XSUB\s0 implementation doesn't support it.
.Sp
Caution : use this option only if you know that your coderefs will be
properly reconstructed by \f(CW\*(C`B::Deparse\*(C'\fR.
.Sh "Exports"
.IX Subsection "Exports"
.IP "Dumper" 4
.IX Item "Dumper"
.SH "EXAMPLES"
.IX Header "EXAMPLES"
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.)
.PP
.Vb 1
\&    use Data::Dumper;
.Ve
.PP
.Vb 2
\&    package Foo;
\&    sub new {bless {'a' => 1, 'b' => sub { return "foo" }}, $_[0]};
.Ve
.PP
.Vb 2
\&    package Fuz;                       # a weird REF-REF-SCALAR object
\&    sub new {bless \e($_ = \e 'fu\e'z'), $_[0]};
.Ve
.PP
.Vb 6
\&    package main;
\&    $foo = Foo->new;
\&    $fuz = Fuz->new;
\&    $boo = [ 1, [], "abcd", \e*foo,
\&             {1 => 'a', 023 => 'b', 0x45 => 'c'}, 
\&             \e\e"p\eq\e'r", $foo, $fuz];
.Ve
.PP
.Vb 3
\&    ########
\&    # simple usage
\&    ########
.Ve
.PP
.Vb 3
\&    $bar = eval(Dumper($boo));
\&    print($@) if $@;
\&    print Dumper($boo), Dumper($bar);  # pretty print (no array indices)
.Ve
.PP
.Vb 3
\&    $Data::Dumper::Terse = 1;          # don't output names where feasible
\&    $Data::Dumper::Indent = 0;         # turn off all pretty print
\&    print Dumper($boo), "\en";
.Ve
.PP
.Vb 2
\&    $Data::Dumper::Indent = 1;         # mild pretty print
\&    print Dumper($boo);
.Ve
.PP
.Vb 2
\&    $Data::Dumper::Indent = 3;         # pretty print with array indices
\&    print Dumper($boo);
.Ve
.PP
.Vb 2
\&    $Data::Dumper::Useqq = 1;          # print strings in double quotes
\&    print Dumper($boo);
.Ve
.PP
.Vb 3
\&    ########
\&    # recursive structures
\&    ########
.Ve
.PP
.Vb 8
\&    @c = ('c');
\&    $c = \e@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)]);
.Ve
.PP
.Vb 3
\&    $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
.Ve
.PP
.Vb 2
\&    $Data::Dumper::Deepcopy = 1;       # avoid cross-refs
\&    print Data::Dumper->Dump([$b, $a], [qw(*b a)]);
.Ve
.PP
.Vb 2
\&    $Data::Dumper::Purity = 0;         # avoid cross-refs
\&    print Data::Dumper->Dump([$b, $a], [qw(*b a)]);
.Ve
.PP
.Vb 3
\&    ########
\&    # deep structures
\&    ########
.Ve
.PP
.Vb 7
\&    $a = "pearl";
\&    $b = [ $a ];
\&    $c = { 'b' => $b };
\&    $d = [ $c ];
\&    $e = { 'd' => $d };
\&    $f = { 'e' => $e };
\&    print Data::Dumper->Dump([$f], [qw(f)]);
.Ve
.PP
.Vb 2
\&    $Data::Dumper::Maxdepth = 3;       # no deeper than 3 refs down
\&    print Data::Dumper->Dump([$f], [qw(f)]);
.Ve
.PP
.Vb 3
\&    ########
\&    # object-oriented usage
\&    ########
.Ve
.PP
.Vb 6
\&    $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->Purity(0);              # empty the seen cache
\&    print join "----\en", $d->Dump;
.Ve
.PP
.Vb 3
\&    ########
\&    # persistence
\&    ########
.Ve
.PP
.Vb 8
\&    package Foo;
\&    sub new { bless { state => 'awake' }, shift }
\&    sub Freeze {
\&        my $s = shift;
\&        print STDERR "preparing to sleep\en";
\&        $s->{state} = 'asleep';
\&        return bless $s, 'Foo::ZZZ';
\&    }
.Ve
.PP
.Vb 7
\&    package Foo::ZZZ;
\&    sub Thaw {
\&        my $s = shift;
\&        print STDERR "waking up\en";
\&        $s->{state} = 'awake';
\&        return bless $s, 'Foo';
\&    }
.Ve
.PP
.Vb 10
\&    package Foo;
\&    use Data::Dumper;
\&    $a = Foo->new;
\&    $b = Data::Dumper->new([$a], ['c']);
\&    $b->Freezer('Freeze');
\&    $b->Toaster('Thaw');
\&    $c = $b->Dump;
\&    print $c;
\&    $d = eval $c;
\&    print Data::Dumper->Dump([$d], ['d']);
.Ve
.PP
.Vb 3
\&    ########
\&    # symbol substitution (useful for recreating CODE refs)
\&    ########
.Ve
.PP
.Vb 6
\&    sub foo { print "foo speaking\en" }
\&    *other = \e&foo;
\&    $bar = [ \e&other ];
\&    $d = Data::Dumper->new([\e&other,$bar],['*other','bar']);
\&    $d->Seen({ '*foo' => \e&foo });
\&    print $d->Dump;
.Ve
.PP
.Vb 3
\&    ########
\&    # sorting and filtering hash keys
\&    ########
.Ve
.PP
.Vb 5
\&    $Data::Dumper::Sortkeys = \e&my_filter;
\&    my $foo = { map { (ord, "$_$_$_") } 'I'..'Q' };
\&    my $bar = { %$foo };
\&    my $baz = { reverse %$foo };
\&    print Dumper [ $foo, $bar, $baz ];
.Ve
.PP
.Vb 13
\&    sub my_filter {
\&        my ($hash) = @_;
\&        # return an array ref containing the hash keys to dump
\&        # in the order that you want them to be dumped
\&        return [
\&          # Sort the keys of %$foo in reverse numeric order
\&            $hash eq $foo ? (sort {$b <=> $a} keys %$hash) :
\&          # Only dump the odd number keys of %$bar
\&            $hash eq $bar ? (grep {$_ % 2} keys %$hash) :
\&          # Sort keys in default order for all other hashes
\&            (sort keys %$hash)
\&        ];
\&    }
.Ve
.SH "BUGS"
.IX Header "BUGS"
Due to limitations of Perl subroutine call semantics, you cannot pass an
array or hash.  Prepend it with a \f(CW\*(C`\e\*(C'\fR to pass its reference instead.  This
will be remedied in time, now that Perl has subroutine prototypes.
For now, you need to use the extended usage form, and prepend the
name with a \f(CW\*(C`*\*(C'\fR to output it as a hash or array.
.PP
\&\f(CW\*(C`Data::Dumper\*(C'\fR cheats with \s-1CODE\s0 references.  If a code reference is
encountered in the structure being processed (and if you haven't set
the \f(CW\*(C`Deparse\*(C'\fR flag), an anonymous subroutine that
contains the string '\*(L"\s-1DUMMY\s0\*(R"' will be inserted in its place, and a warning
will be printed if \f(CW\*(C`Purity\*(C'\fR is set.  You can \f(CW\*(C`eval\*(C'\fR 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.  If you have prior
knowledge of all the code refs that your data structures are likely
to have, you can use the \f(CW\*(C`Seen\*(C'\fR method to pre-seed the internal reference
table and make the dumped output point to them, instead.  See \s-1EXAMPLES\s0
above.
.PP
The \f(CW\*(C`Useqq\*(C'\fR and \f(CW\*(C`Deparse\*(C'\fR flags makes \fIDump()\fR run slower, since the
\&\s-1XSUB\s0 implementation does not support them.
.PP
\&\s-1SCALAR\s0 objects have the weirdest looking \f(CW\*(C`bless\*(C'\fR workaround.
.SH "AUTHOR"
.IX Header "AUTHOR"
Gurusamy Sarathy        gsar@activestate.com
.PP
Copyright (c) 1996\-98 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.
.SH "VERSION"
.IX Header "VERSION"
Version 2.12   (unreleased)
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1)