projects / OpenSPARC-T2-SAM / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man3 / Dumpvalue.3
CommitLineData
920dae64
AT		 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2.\"
3.\" Standard preamble:
4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v
15.if n .sp
16..
17.de Vb \" Begin verbatim text
18.ft CW
19.nf
20.ne \\$1
21..
22.de Ve \" End verbatim text
23.ft R
24.fi
25..
26.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31.\" expand to `' in nroff, nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\
35. ds -- \(*W-
36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" ""
40. ds R" ""
41. ds C` ""
42. ds C' ""
43'br\}
44.el\{\
45. ds -- \|\(em\|
46. ds PI \(*p
47. ds L" ``
48. ds R" ''
49'br\}
50.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion.
55.if \nF \{\
56. de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58..
59. nr % 0
60. rr F
61.\}
62.\"
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff
71.if n \{\
72. ds #H 0
73. ds #V .8m
74. ds #F .3m
75. ds #[ \f1
76. ds #] \fP
77.\}
78.if t \{\
79. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80. ds #V .6m
81. ds #F 0
82. ds #[ \&
83. ds #] \&
84.\}
85. \" simple accents for nroff and troff
86.if n \{\
87. ds ' \&
88. ds ` \&
89. ds ^ \&
90. ds , \&
91. ds ~ ~
92. ds /
93.\}
94.if t \{\
95. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101.\}
102. \" troff and (daisy-wheel) nroff accents
103.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110.ds ae a\h'-(\w'a'u*4/10)'e
111.ds Ae A\h'-(\w'A'u*4/10)'E
112. \" corrections for vroff
113.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115. \" for low resolution devices (crt and lpr)
116.if \n(.H>23 .if \n(.V>19 \
117\{\
118. ds : e
119. ds 8 ss
120. ds o a
121. ds d- d\h'-1'\(ga
122. ds D- D\h'-1'\(hy
123. ds th \o'bp'
124. ds Th \o'LP'
125. ds ae ae
126. ds Ae AE
127.\}
128.rm #[ #] #H #V #F C
129.\" ========================================================================
130.\"
131.IX Title "Dumpvalue 3"
132.TH Dumpvalue 3 "2001-09-21" "perl v5.8.8" "Perl Programmers Reference Guide"
133.SH "NAME"
134Dumpvalue \- provides screen dump of Perl data.
135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS"
137.Vb 6
138\& use Dumpvalue;
139\& my $dumper = new Dumpvalue;
140\& $dumper->set(globPrint => 1);
141\& $dumper->dumpValue(\e*::);
142\& $dumper->dumpvars('main');
143\& my $dump = $dumper->stringify($some_value);
144.Ve
145.SH "DESCRIPTION"
146.IX Header "DESCRIPTION"
147.Sh "Creation"
148.IX Subsection "Creation"
149A new dumper is created by a call
150.PP
151.Vb 1
152\& $d = new Dumpvalue(option1 => value1, option2 => value2)
153.Ve
154.PP
155Recognized options:
156.ie n .IP """arrayDepth""\fR, \f(CW""hashDepth""" 4
157.el .IP "\f(CWarrayDepth\fR, \f(CWhashDepth\fR" 4
158.IX Item "arrayDepth, hashDepth"
159Print only first N elements of arrays and hashes. If false, prints all the
160elements.
161.ie n .IP """compactDump""\fR, \f(CW""veryCompact""" 4
162.el .IP "\f(CWcompactDump\fR, \f(CWveryCompact\fR" 4
163.IX Item "compactDump, veryCompact"
164Change style of array and hash dump. If true, short array
165may be printed on one line.
166.ie n .IP """globPrint""" 4
167.el .IP "\f(CWglobPrint\fR" 4
168.IX Item "globPrint"
169Whether to print contents of globs.
170.ie n .IP """dumpDBFiles""" 4
171.el .IP "\f(CWdumpDBFiles\fR" 4
172.IX Item "dumpDBFiles"
173Dump arrays holding contents of debugged files.
174.ie n .IP """dumpPackages""" 4
175.el .IP "\f(CWdumpPackages\fR" 4
176.IX Item "dumpPackages"
177Dump symbol tables of packages.
178.ie n .IP """dumpReused""" 4
179.el .IP "\f(CWdumpReused\fR" 4
180.IX Item "dumpReused"
181Dump contents of \*(L"reused\*(R" addresses.
182.ie n .IP """tick""\fR, \f(CW""quoteHighBit""\fR, \f(CW""printUndef""" 4
183.el .IP "\f(CWtick\fR, \f(CWquoteHighBit\fR, \f(CWprintUndef\fR" 4
184.IX Item "tick, quoteHighBit, printUndef"
185Change style of string dump. Default value of \f(CW\*(C`tick\*(C'\fR is \f(CW\*(C`auto\*(C'\fR, one
186can enable either double-quotish dump, or single-quotish by setting it
187to \f(CW\*(C`"\*(C'\fR or \f(CW\*(C`'\*(C'\fR. By default, characters with high bit set are printed
188\&\fIas is\fR. If \f(CW\*(C`quoteHighBit\*(C'\fR is set, they will be quoted.
189.ie n .IP """usageOnly""" 4
190.el .IP "\f(CWusageOnly\fR" 4
191.IX Item "usageOnly"
192rudimentally per-package memory usage dump. If set,
193\&\f(CW\*(C`dumpvars\*(C'\fR calculates total size of strings in variables in the package.
194.IP "unctrl" 4
195.IX Item "unctrl"
196Changes the style of printout of strings. Possible values are
197\&\f(CW\*(C`unctrl\*(C'\fR and \f(CW\*(C`quote\*(C'\fR.
198.IP "subdump" 4
199.IX Item "subdump"
200Whether to try to find the subroutine name given the reference.
201.IP "bareStringify" 4
202.IX Item "bareStringify"
203Whether to write the non-overloaded form of the stringify-overloaded objects.
204.IP "quoteHighBit" 4
205.IX Item "quoteHighBit"
206Whether to print chars with high bit set in binary or \*(L"as is\*(R".
207.IP "stopDbSignal" 4
208.IX Item "stopDbSignal"
209Whether to abort printing if debugger signal flag is raised.
210.PP
211Later in the life of the object the methods may be queries with \fIget()\fR
212method and \fIset()\fR method (which accept multiple arguments).
213.Sh "Methods"
214.IX Subsection "Methods"
215.IP "dumpValue" 4
216.IX Item "dumpValue"
217.Vb 2
218\& $dumper->dumpValue($value);
219\& $dumper->dumpValue([$value1, $value2]);
220.Ve
221.Sp
222Prints a dump to the currently selected filehandle.
223.IP "dumpValues" 4
224.IX Item "dumpValues"
225.Vb 1
226\& $dumper->dumpValues($value1, $value2);
227.Ve
228.Sp
229Same as \f(CW\*(C` $dumper\-\*(C'\fRdumpValue([$value1, \f(CW$value2\fR]); >.
230.IP "stringify" 4
231.IX Item "stringify"
232.Vb 1
233\& my $dump = $dumper->stringify($value [,$noticks] );
234.Ve
235.Sp
236Returns the dump of a single scalar without printing. If the second
237argument is true, the return value does not contain enclosing ticks.
238Does not handle data structures.
239.IP "dumpvars" 4
240.IX Item "dumpvars"
241.Vb 2
242\& $dumper->dumpvars('my_package');
243\& $dumper->dumpvars('my_package', 'foo', '~bar$', '!......');
244.Ve
245.Sp
246The optional arguments are considered as literal strings unless they
247start with \f(CW\*(C`~\*(C'\fR or \f(CW\*(C`!\*(C'\fR, in which case they are interpreted as regular
248expressions (possibly negated).
249.Sp
250The second example prints entries with names \f(CW\*(C`foo\*(C'\fR, and also entries
251with names which ends on \f(CW\*(C`bar\*(C'\fR, or are shorter than 5 chars.
252.IP "set_quote" 4
253.IX Item "set_quote"
254.Vb 1
255\& $d->set_quote('"');
256.Ve
257.Sp
258Sets \f(CW\*(C`tick\*(C'\fR and \f(CW\*(C`unctrl\*(C'\fR options to suitable values for printout with the
259given quote char. Possible values are \f(CW\*(C`auto\*(C'\fR, \f(CW\*(C`'\*(C'\fR and \f(CW\*(C`"\*(C'\fR.
260.IP "set_unctrl" 4
261.IX Item "set_unctrl"
262.Vb 1
263\& $d->set_unctrl('unctrl');
264.Ve
265.Sp
266Sets \f(CW\*(C`unctrl\*(C'\fR option with checking for an invalid argument.
267Possible values are \f(CW\*(C`unctrl\*(C'\fR and \f(CW\*(C`quote\*(C'\fR.
268.IP "compactDump" 4
269.IX Item "compactDump"
270.Vb 1
271\& $d->compactDump(1);
272.Ve
273.Sp
274Sets \f(CW\*(C`compactDump\*(C'\fR option. If the value is 1, sets to a reasonable
275big number.
276.IP "veryCompact" 4
277.IX Item "veryCompact"
278.Vb 1
279\& $d->veryCompact(1);
280.Ve
281.Sp
282Sets \f(CW\*(C`compactDump\*(C'\fR and \f(CW\*(C`veryCompact\*(C'\fR options simultaneously.
283.IP "set" 4
284.IX Item "set"
285.Vb 1
286\& $d->set(option1 => value1, option2 => value2);
287.Ve
288.IP "get" 4
289.IX Item "get"
290.Vb 1
291\& @values = $d->get('option1', 'option2');
292.Ve
Full OpenSPARC architecture tarball including simulator, hypervisor, and OBP.