home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _cb46883c3046081a72e9a5a58d8aa85c < prev    next >
Text File  |  2000-03-23  |  7KB  |  188 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Dumpvalue - provides screen dump of Perl data.</TITLE>
  5. <LINK REL="stylesheet" HREF="../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> Dumpvalue - provides screen dump of Perl data.</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <UL>
  26.  
  27.         <LI><A HREF="#creation">Creation</A></LI>
  28.         <LI><A HREF="#methods">Methods</A></LI>
  29.     </UL>
  30.  
  31. </UL>
  32. <!-- INDEX END -->
  33.  
  34. <HR>
  35. <P>
  36. <H1><A NAME="name">NAME</A></H1>
  37. <P>Dumpvalue - provides screen dump of Perl data.</P>
  38. <P>
  39. <HR>
  40. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  41. <UL>
  42. <LI>Linux</LI>
  43. <LI>Solaris</LI>
  44. <LI>Windows</LI>
  45. </UL>
  46. <HR>
  47. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  48. <PRE>
  49.   use Dumpvalue;
  50.   my $dumper = new Dumpvalue;
  51.   $dumper->set(globPrint => 1);
  52.   $dumper->dumpValue(\*::);
  53.   $dumper->dumpvars('main');</PRE>
  54. <P>
  55. <HR>
  56. <H1><A NAME="description">DESCRIPTION</A></H1>
  57. <P>
  58. <H2><A NAME="creation">Creation</A></H2>
  59. <P>A new dumper is created by a call</P>
  60. <PRE>
  61.   $d = new Dumpvalue(option1 => value1, option2 => value2)</PRE>
  62. <P>Recognized options:</P>
  63. <DL>
  64. <DT><STRONG><A NAME="item_arrayDepth%2C_hashDepth"><CODE>arrayDepth</CODE>, <CODE>hashDepth</CODE></A></STRONG><BR>
  65. <DD>
  66. Print only first N elements of arrays and hashes.  If false, prints all the
  67. elements.
  68. <P></P>
  69. <DT><STRONG><A NAME="item_compactDump%2C_veryCompact"><A HREF="#item_compactDump"><CODE>compactDump</CODE></A>, <A HREF="#item_veryCompact"><CODE>veryCompact</CODE></A></A></STRONG><BR>
  70. <DD>
  71. Change style of array and hash dump.  If true, short array
  72. may be printed on one line.
  73. <P></P>
  74. <DT><STRONG><A NAME="item_globPrint"><CODE>globPrint</CODE></A></STRONG><BR>
  75. <DD>
  76. Whether to print contents of globs.
  77. <P></P>
  78. <DT><STRONG><A NAME="item_DumpDBFiles"><CODE>DumpDBFiles</CODE></A></STRONG><BR>
  79. <DD>
  80. Dump arrays holding contents of debugged files.
  81. <P></P>
  82. <DT><STRONG><A NAME="item_DumpPackages"><CODE>DumpPackages</CODE></A></STRONG><BR>
  83. <DD>
  84. Dump symbol tables of packages.
  85. <P></P>
  86. <DT><STRONG><A NAME="item_DumpReused"><CODE>DumpReused</CODE></A></STRONG><BR>
  87. <DD>
  88. Dump contents of ``reused'' addresses.
  89. <P></P>
  90. <DT><STRONG><A NAME="item_tick%2C_HighBit%2C_printUndef"><CODE>tick</CODE>, <CODE>HighBit</CODE>, <CODE>printUndef</CODE></A></STRONG><BR>
  91. <DD>
  92. Change style of string dump.  Default value of <CODE>tick</CODE> is <CODE>auto</CODE>, one
  93. can enable either double-quotish dump, or single-quotish by setting it
  94. to <CODE>"</CODE> or <CODE>'</CODE>.  By default, characters with high bit set are printed
  95. <EM>as is</EM>.
  96. <P></P>
  97. <DT><STRONG><A NAME="item_UsageOnly"><CODE>UsageOnly</CODE></A></STRONG><BR>
  98. <DD>
  99. <EM>very</EM> rudimentally per-package memory usage dump.  If set,
  100. <A HREF="#item_dumpvars"><CODE>dumpvars</CODE></A> calculates total size of strings in variables in the package.
  101. <P></P>
  102. <DT><STRONG><A NAME="item_unctrl">unctrl</A></STRONG><BR>
  103. <DD>
  104. Changes the style of printout of strings.  Possible values are
  105. <A HREF="#item_unctrl"><CODE>unctrl</CODE></A> and <CODE>quote</CODE>.
  106. <P></P>
  107. <DT><STRONG><A NAME="item_subdump">subdump</A></STRONG><BR>
  108. <DD>
  109. Whether to try to find the subroutine name given the reference.
  110. <P></P>
  111. <DT><STRONG><A NAME="item_bareStringify">bareStringify</A></STRONG><BR>
  112. <DD>
  113. Whether to write the non-overloaded form of the stringify-overloaded objects.
  114. <P></P>
  115. <DT><STRONG><A NAME="item_quoteHighBit">quoteHighBit</A></STRONG><BR>
  116. <DD>
  117. Whether to print chars with high bit set in binary or ``as is''.
  118. <P></P>
  119. <DT><STRONG><A NAME="item_stopDbSignal">stopDbSignal</A></STRONG><BR>
  120. <DD>
  121. Whether to abort printing if debugger signal flag is raised.
  122. <P></P></DL>
  123. <P>Later in the life of the object the methods may be queries with <A HREF="#item_get"><CODE>get()</CODE></A>
  124. method and <A HREF="#item_set"><CODE>set()</CODE></A> method (which accept multiple arguments).</P>
  125. <P>
  126. <H2><A NAME="methods">Methods</A></H2>
  127. <DL>
  128. <DT><STRONG><A NAME="item_dumpValue">dumpValue</A></STRONG><BR>
  129. <DD>
  130. <PRE>
  131.   $dumper->dumpValue($value);
  132.   $dumper->dumpValue([$value1, $value2]);</PRE>
  133. <DT><STRONG><A NAME="item_dumpValues">dumpValues</A></STRONG><BR>
  134. <DD>
  135. <PRE>
  136.   $dumper->dumpValues($value1, $value2);</PRE>
  137. <DT><STRONG><A NAME="item_dumpvars">dumpvars</A></STRONG><BR>
  138. <DD>
  139. <PRE>
  140.   $dumper->dumpvars('my_package');
  141.   $dumper->dumpvars('my_package', 'foo', '~bar$', '!......');</PRE>
  142. <P>The optional arguments are considered as literal strings unless they
  143. start with <CODE>~</CODE> or <CODE>!</CODE>, in which case they are interpreted as regular
  144. expressions (possibly negated).</P>
  145. <P>The second example prints entries with names <CODE>foo</CODE>, and also entries
  146. with names which ends on <CODE>bar</CODE>, or are shorter than 5 chars.</P>
  147. <DT><STRONG><A NAME="item_set_quote">set_quote</A></STRONG><BR>
  148. <DD>
  149. <PRE>
  150.   $d->set_quote('"');</PRE>
  151. <P>Sets <CODE>tick</CODE> and <A HREF="#item_unctrl"><CODE>unctrl</CODE></A> options to suitable values for printout with the
  152. given quote char.  Possible values are <CODE>auto</CODE>, <CODE>'</CODE> and <CODE>"</CODE>.</P>
  153. <DT><STRONG><A NAME="item_set_unctrl">set_unctrl</A></STRONG><BR>
  154. <DD>
  155. <PRE>
  156.   $d->set_unctrl('"');</PRE>
  157. <P>Sets <A HREF="#item_unctrl"><CODE>unctrl</CODE></A> option with checking for an invalid argument.
  158. Possible values are <A HREF="#item_unctrl"><CODE>unctrl</CODE></A> and <CODE>quote</CODE>.</P>
  159. <DT><STRONG><A NAME="item_compactDump">compactDump</A></STRONG><BR>
  160. <DD>
  161. <PRE>
  162.   $d->compactDump(1);</PRE>
  163. <P>Sets <A HREF="#item_compactDump"><CODE>compactDump</CODE></A> option.  If the value is 1, sets to a reasonable
  164. big number.</P>
  165. <DT><STRONG><A NAME="item_veryCompact">veryCompact</A></STRONG><BR>
  166. <DD>
  167. <PRE>
  168.   $d->veryCompact(1);</PRE>
  169. <P>Sets <A HREF="#item_compactDump"><CODE>compactDump</CODE></A> and <A HREF="#item_veryCompact"><CODE>veryCompact</CODE></A> options simultaneously.</P>
  170. <DT><STRONG><A NAME="item_set">set</A></STRONG><BR>
  171. <DD>
  172. <PRE>
  173.   $d->set(option1 => value1, option2 => value2);</PRE>
  174. <DT><STRONG><A NAME="item_get">get</A></STRONG><BR>
  175. <DD>
  176. <PRE>
  177.   @values = $d->get('option1', 'option2');</PRE>
  178. </DL>
  179. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  180. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  181. <STRONG><P CLASS=block> Dumpvalue - provides screen dump of Perl data.</P></STRONG>
  182. </TD></TR>
  183. </TABLE>
  184.  
  185. </BODY>
  186.  
  187. </HTML>
  188.