home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _f464607c34476a4e07c868ed0eb10279 < prev    next >
Text File  |  2000-03-23  |  8KB  |  197 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>Devel::Symdump - dump symbol names or the symbol table</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> Devel::Symdump - dump symbol names or the symbol table</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="#incompatibility alert">INCOMPATIBILITY ALERT</A></LI>
  25.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  26.     <UL>
  27.  
  28.         <LI><A HREF="#devel::symdump>rnew(@packages)"><CODE>Devel::Symdump->rnew(@packages)</CODE></A></LI>
  29.         <LI><A HREF="#devel::symdump>new(@packages)"><CODE>Devel::Symdump->new(@packages)</CODE></A></LI>
  30.     </UL>
  31.  
  32.     <LI><A HREF="#subclassing">SUBCLASSING</A></LI>
  33.     <LI><A HREF="#authors">AUTHORS</A></LI>
  34. </UL>
  35. <!-- INDEX END -->
  36.  
  37. <HR>
  38. <P>
  39. <H1><A NAME="name">NAME</A></H1>
  40. <P>Devel::Symdump - dump symbol names or the symbol table</P>
  41. <P>
  42. <HR>
  43. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  44. <UL>
  45. <LI>Linux</LI>
  46. <LI>Solaris</LI>
  47. <LI>Windows</LI>
  48. </UL>
  49. <HR>
  50. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  51. <PRE>
  52.     # Constructor
  53.     require Devel::Symdump;
  54.     @packs = qw(some_package another_package);
  55.     $obj = Devel::Symdump->new(@packs);        # no recursion
  56.     $obj = Devel::Symdump->rnew(@packs);       # with recursion
  57. </PRE>
  58. <PRE>
  59.  
  60.     # Methods
  61.     @array = $obj->packages;
  62.     @array = $obj->scalars;
  63.     @array = $obj->arrays;
  64.     @array = $obj->hashs;
  65.     @array = $obj->functions;
  66.     @array = $obj->filehandles;  # deprecated, use ios instead
  67.     @array = $obj->dirhandles;   # deprecated, use ios instead
  68.     @array = $obj->ios;
  69.     @array = $obj->unknowns;</PRE>
  70. <PRE>
  71.  
  72.     $string = $obj->as_string;
  73.     $string = $obj->as_HTML;
  74.     $string = $obj1->diff($obj2);</PRE>
  75. <PRE>
  76.     $string = Devel::Symdump->isa_tree;    # or $obj->isa_tree
  77.     $string = Devel::Symdump->inh_tree;    # or $obj->inh_tree</PRE>
  78. <PRE>
  79.     # Methods with autogenerated objects
  80.     # all of those call new(@packs) internally
  81.     @array = Devel::Symdump->packages(@packs);
  82.     @array = Devel::Symdump->scalars(@packs);
  83.     @array = Devel::Symdump->arrays(@packs);
  84.     @array = Devel::Symdump->hashes(@packs);
  85.     @array = Devel::Symdump->functions(@packs);
  86.     @array = Devel::Symdump->ios(@packs);
  87.     @array = Devel::Symdump->unknowns(@packs);</PRE>
  88. <P>
  89. <HR>
  90. <H1><A NAME="incompatibility alert">INCOMPATIBILITY ALERT</A></H1>
  91. <P>Perl 5.003 already offered the opportunity to test for the individual
  92. slots of a GLOB with the *GLOB{XXX} notation. Devel::Symdump version
  93. 2.00 uses this method internally which means that the type of
  94. undefined values is recognized in general. Previous versions
  95. couldn&39;t determine the type of undefined values, so the slot
  96. <EM>unknowns</EM> was invented. From version 2.00 this slot is still present
  97. but will usually not contain any elements.</P>
  98. <P>The interface has changed slightly between the perl versions 5.003 and
  99. 5.004. To be precise, from perl5.003_11 the names of the members of a
  100. GLOB have changed. <CODE>IO</CODE> is the internal name for all kinds of
  101. input-output handles while <CODE>FILEHANDLE</CODE> and <CODE>DIRHANDLE</CODE> are
  102. deprecated.</P>
  103. <P><CODE>Devel::Symdump</CODE> accordingly introduces the new method <CODE>ios()</CODE> which
  104. returns filehandles <STRONG>and</STRONG> directory handles. The old methods
  105. <CODE>filehandles()</CODE> and <CODE>dirhandles()</CODE> are still supported for a transitional
  106. period.  They will probably have to go in future versions.</P>
  107. <P>
  108. <HR>
  109. <H1><A NAME="description">DESCRIPTION</A></H1>
  110. <P>This little package serves to access the symbol table of perl.</P>
  111. <P>
  112. <H2><A NAME="devel::symdump>rnew(@packages)"><CODE>Devel::Symdump->rnew(@packages)</CODE></A></H2>
  113. <P>returns a symbol table object for all subtrees below @packages.
  114. Nested Modules are analyzed recursively. If no package is given as
  115. argument, it defaults to <CODE>main</CODE>. That means to get the whole symbol
  116. table, just do a <CODE>rnew</CODE> without arguments.</P>
  117. <P>
  118. <H2><A NAME="devel::symdump>new(@packages)"><CODE>Devel::Symdump->new(@packages)</CODE></A></H2>
  119. <P>does not go into recursion and only analyzes the packages that are
  120. given as arguments.</P>
  121. <P>The methods packages(), scalars(), arrays(), hashes(), functions(),
  122. ios(), and <CODE>unknowns()</CODE> each return an array of fully qualified
  123. symbols of the specified type in all packages that are held within a
  124. Devel::Symdump object, but without the leading <CODE>$</CODE>, <CODE>@</CODE> or <CODE>%</CODE>.  In
  125. a scalar context, they will return the number of such symbols.
  126. Unknown symbols are usually either formats or variables that haven&39;t
  127. yet got a defined value.</P>
  128. <P><CODE>As_string()</CODE> and <CODE>as_HTML()</CODE> return a simple string/HTML representations
  129. of the object.</P>
  130. <P><CODE>Diff()</CODE> prints the difference between two Devel::Symdump objects in
  131. human readable form. The format is similar to the one used by the
  132. as_string method.</P>
  133. <P><CODE>Isa_tree()</CODE> and <A HREF="#item_inh_tree"><CODE>inh_tree()</CODE></A> both return a simple string representation
  134. of the current inheritance tree. The difference between the two
  135. methods is the direction from which the tree is viewed: top-down or
  136. bottom-up. As I&39;m sure, many users will have different expectation
  137. about what is top and what is bottom, I&39;ll provide an example what
  138. happens when the Socket module is loaded:</P>
  139. <DL>
  140. <DT><STRONG><A NAME="item_inh_tree">% print Devel::Symdump->inh_tree</A></STRONG><BR>
  141. <DD>
  142. <PRE>
  143.     AutoLoader
  144.             DynaLoader
  145.                     Socket
  146.     DynaLoader
  147.             Socket
  148.     Exporter
  149.             Carp
  150.             Config
  151.             Socket</PRE>
  152. <P>The inh_tree method shows on the left hand side a package name and
  153. indented to the right the packages that use the former.</P>
  154. <DT><STRONG><A NAME="item_isa_tree">% print Devel::Symdump->isa_tree</A></STRONG><BR>
  155. <DD>
  156. <PRE>
  157.     Carp
  158.             Exporter
  159.     Config
  160.             Exporter
  161.     DynaLoader
  162.             AutoLoader
  163.     Socket
  164.             Exporter
  165.             DynaLoader
  166.                     AutoLoader</PRE>
  167. <P>The isa_tree method displays from left to right ISA relationships, so
  168. Socket IS A DynaLoader and DynaLoader IS A AutoLoader. (At least at
  169. the time this manpage was written :-)</P>
  170. </DL>
  171. <P>You may call both methods, <A HREF="#item_isa_tree"><CODE>isa_tree()</CODE></A> and inh_tree(), with an
  172. object. If you do that, the object will store the output and retrieve
  173. it when you call the same method again later. The typical usage would
  174. be to use them as class methods directly though.</P>
  175. <P>
  176. <HR>
  177. <H1><A NAME="subclassing">SUBCLASSING</A></H1>
  178. <P>The design of this package is intentionally primitive and allows it to
  179. be subclassed easily. An example of a (maybe) useful subclass is
  180. Devel::Symdump::Export, a package which exports all methods of the
  181. Devel::Symdump package and turns them into functions.</P>
  182. <P>
  183. <HR>
  184. <H1><A NAME="authors">AUTHORS</A></H1>
  185. <P>Andreas Koenig <EM><<A HREF="mailto:koenig@franz.ww.TU-Berlin.DE">koenig@franz.ww.TU-Berlin.DE</A>></EM> and Tom
  186. Christiansen <EM><<A HREF="mailto:tchrist@perl.com">tchrist@perl.com</A>></EM>.  Based on the old
  187. <EM>dumpvar.pl</EM> by Larry Wall.</P>
  188. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  189. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  190. <STRONG><P CLASS=block> Devel::Symdump - dump symbol names or the symbol table</P></STRONG>
  191. </TD></TR>
  192. </TABLE>
  193.  
  194. </BODY>
  195.  
  196. </HTML>
  197.