1   <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/frameset.dtd">
  2  
  3   <HTML>
  4   <HEAD>
  5     <TITLE>XOTcl - Documentation -- ./library/lib/trace.xotcl</TITLE>
  6   </HEAD>
  7  
  8   <BODY BGCOLOR="FFFFFF">
  9     <h1>
  10       <IMG SRC="./logo-100.jpg" ALT="./library/lib/trace.xotcl" ALIGN="MIDDLE">
  11     ./library/lib/trace.xotcl</h1>
  12     <HR>
  13     <P>
  14       <h2> Package/File Information </h2>
  15       <b> Package provided: </b> xotcl::trace 0.91
  16       <BR>
  17       <BR>
  18       <b>Defined Objects/Classes: </b>
  19       <UL>
  20         <LI>
  21           <A HREF="#Object">
  22             <em>Object</em>:
  23           </A>
  24           <a href="#Object-lintFilter">lintFilter</a>, <a href="#Object-showCall">showCall</a>, <a href="#Object-showClass">showClass</a>, <a href="#Object-showMsg">showMsg</a>, <a href="#Object-showStack">showStack</a>, <a href="#Object-showTimeEnd">showTimeEnd</a>, <a href="#Object-showTimeStart">showTimeStart</a>, <a href="#Object-showVars">showVars</a>, <a href="#Object-statFilter">statFilter</a>, <a href="#Object-traceFilter">traceFilter</a>.
  25           <BR>
  26         </LI>
  27         <LI>
  28           <A HREF="#Trace">
  29             <em>Trace</em>:
  30           </A>
  31           <a href="#Trace-closeTraceFile">closeTraceFile</a>, <a href="#Trace-openTraceFile">openTraceFile</a>, <a href="#Trace-puts">puts</a>.
  32           <BR>
  33         </LI>
  34       </UL>
  35       <BR>
  36       <b> Filename: </b>
  37       <A HREF="./library/lib/trace.xotcl">
  38         ./library/lib/trace.xotcl
  39       </A>
  40       <BR>
  41       <BR>
  42       <TABLE BORDER="0">
  43         <TR VALIGN="top">
  44           <TD VALIGN="top">
  45             <em> Description:</em>
  46           </TD>
  47           <TD VALIGN="top">
  48            
  49     Various tracing tools for the XOTcl language.
  50    
  51           </TD>
  52         </TR>
  53       </TABLE>
  54       <BR>
  55       <HR>
  56       <P>
  57         <A NAME="Object">
  58          
  59         </A>
  60         <h2> Class: <em> Object </em> </h2>
  61         <b> Procs/Instprocs: </b>
  62         <a href="#Object-lintFilter">lintFilter</a>, <a href="#Object-showCall">showCall</a>, <a href="#Object-showClass">showClass</a>, <a href="#Object-showMsg">showMsg</a>, <a href="#Object-showStack">showStack</a>, <a href="#Object-showTimeEnd">showTimeEnd</a>, <a href="#Object-showTimeStart">showTimeStart</a>, <a href="#Object-showVars">showVars</a>, <a href="#Object-statFilter">statFilter</a>, <a href="#Object-traceFilter">traceFilter</a>.
  63         <TABLE BORDER="0">
  64         </TABLE>
  65         <h3>Instprocs</h3>
  66         <UL>
  67           <LI>
  68             <A NAME="Object-traceFilter">
  69              
  70             </A>
  71             <b>traceFilter </b>
  72             <em>args</em>
  73             <TABLE BORDER="0">
  74                         <TR VALIGN="top">
  75               <TD VALIGN="top">
  76                 <em>Arguments:</em>
  77               </TD>
  78               <TD VALIGN="top">
  79                 <b>args</b>: arbitrary args
  80               </TD>
  81             </TR>
  82  
  83               <TR VALIGN="top">
  84                 <TD VALIGN="top">
  85                   <em> Description:</em>
  86                 </TD>
  87                 <TD VALIGN="top">
  88                  
  89         Filter to trace every method call on an object or class hierarchy.
  90         Outputs a message befora and after each call of the traced object.
  91      
  92                 </TD>
  93               </TR>
  94               <TR VALIGN="top">
  95                 <TD VALIGN="top">
  96                   <em> Return:</em>
  97                 </TD>
  98                 <TD VALIGN="top">
  99                   empty string
  100                 </TD>
  101               </TR>
  102             </TABLE>
  103           </LI>
  104           <LI>
  105             <A NAME="Object-lintFilter">
  106              
  107             </A>
  108             <b>lintFilter </b>
  109             <TABLE BORDER="0">
  110              
  111               <TR VALIGN="top">
  112                 <TD VALIGN="top">
  113                   <em> Description:</em>
  114                 </TD>
  115                 <TD VALIGN="top">
  116                   Experimental lint filter
  117                 </TD>
  118               </TR>
  119             </TABLE>
  120           </LI>
  121           <LI>
  122             <A NAME="Object-statFilter">
  123              
  124             </A>
  125             <b>statFilter </b>
  126             <TABLE BORDER="0">
  127              
  128               <TR VALIGN="top">
  129                 <TD VALIGN="top">
  130                   <em> Description:</em>
  131                 </TD>
  132                 <TD VALIGN="top">
  133                   Experimental statistics filter
  134                 </TD>
  135               </TR>
  136             </TABLE>
  137           </LI>
  138           <LI>
  139             <A NAME="Object-showVars">
  140              
  141             </A>
  142             <b>showVars </b>
  143             <em>args</em>
  144             <TABLE BORDER="0">
  145                         <TR VALIGN="top">
  146               <TD VALIGN="top">
  147                 <em>Arguments:</em>
  148               </TD>
  149               <TD VALIGN="top">
  150                 <b>args</b>: ist of variables
  151               </TD>
  152             </TR>
  153  
  154               <TR VALIGN="top">
  155                 <TD VALIGN="top">
  156                   <em> Description:</em>
  157                 </TD>
  158                 <TD VALIGN="top">
  159                   Show the values of the specified variables (or of all variables)
  160       of an object on stderr.
  161                 </TD>
  162               </TR>
  163             </TABLE>
  164           </LI>
  165           <LI>
  166             <A NAME="Object-showMsg">
  167              
  168             </A>
  169             <b>showMsg </b>
  170             <em>msg</em>
  171             <TABLE BORDER="0">
  172                         <TR VALIGN="top">
  173               <TD VALIGN="top">
  174                 <em>Arguments:</em>
  175               </TD>
  176               <TD VALIGN="top">
  177                 <b>msg</b>: optional output
  178               </TD>
  179             </TR>
  180  
  181               <TR VALIGN="top">
  182                 <TD VALIGN="top">
  183                   <em> Description:</em>
  184                 </TD>
  185                 <TD VALIGN="top">
  186                   Show a message msg with the form "[self] $cls->$method $msg" on stderr.
  187                 </TD>
  188               </TR>
  189             </TABLE>
  190           </LI>
  191           <LI>
  192             <A NAME="Object-showClass">
  193              
  194             </A>
  195             <b>showClass </b>
  196             <TABLE BORDER="0">
  197              
  198               <TR VALIGN="top">
  199                 <TD VALIGN="top">
  200                   <em> Description:</em>
  201                 </TD>
  202                 <TD VALIGN="top">
  203                   Show classes and mixins of the object
  204                 </TD>
  205               </TR>
  206             </TABLE>
  207           </LI>
  208           <LI>
  209             <A NAME="Object-showStack">
  210              
  211             </A>
  212             <b>showStack </b>
  213             <em>maxDepth</em>
  214             <TABLE BORDER="0">
  215                         <TR VALIGN="top">
  216               <TD VALIGN="top">
  217                 <em>Arguments:</em>
  218               </TD>
  219               <TD VALIGN="top">
  220                 <b>maxDepth</b>: max stack depth, default=100
  221               </TD>
  222             </TR>
  223  
  224               <TR VALIGN="top">
  225                 <TD VALIGN="top">
  226                   <em> Description:</em>
  227                 </TD>
  228                 <TD VALIGN="top">
  229                   Show callstack up to the specified calldepth.
  230                 </TD>
  231               </TR>
  232             </TABLE>
  233           </LI>
  234           <LI>
  235             <A NAME="Object-showCall">
  236              
  237             </A>
  238             <b>showCall </b>
  239             <TABLE BORDER="0">
  240              
  241               <TR VALIGN="top">
  242                 <TD VALIGN="top">
  243                   <em> Description:</em>
  244                 </TD>
  245                 <TD VALIGN="top">
  246                   Show the current call with the form "[self] $cls->$method $args" on stderr.
  247                 </TD>
  248               </TR>
  249             </TABLE>
  250           </LI>
  251           <LI>
  252             <A NAME="Object-showTimeStart">
  253              
  254             </A>
  255             <b>showTimeStart </b>
  256             <em>?handle?</em>
  257             <TABLE BORDER="0">
  258                         <TR VALIGN="top">
  259               <TD VALIGN="top">
  260                 <em>Arguments:</em>
  261               </TD>
  262               <TD VALIGN="top">
  263                 <b>?handle?</b>: Handle object name, optional
  264               </TD>
  265             </TR>
  266  
  267               <TR VALIGN="top">
  268                 <TD VALIGN="top">
  269                   <em> Description:</em>
  270                 </TD>
  271                 <TD VALIGN="top">
  272                   start a timer
  273                 </TD>
  274               </TR>
  275             </TABLE>
  276           </LI>
  277           <LI>
  278             <A NAME="Object-showTimeEnd">
  279              
  280             </A>
  281             <b>showTimeEnd </b>
  282             <em>?handle?</em>
  283             <TABLE BORDER="0">
  284                         <TR VALIGN="top">
  285               <TD VALIGN="top">
  286                 <em>Arguments:</em>
  287               </TD>
  288               <TD VALIGN="top">
  289                 <b>?handle?</b>: Handle object name, optional
  290               </TD>
  291             </TR>
  292  
  293               <TR VALIGN="top">
  294                 <TD VALIGN="top">
  295                   <em> Description:</em>
  296                 </TD>
  297                 <TD VALIGN="top">
  298                   end a timer and show result
  299                 </TD>
  300               </TR>
  301             </TABLE>
  302           </LI>
  303         </UL>
  304       </P>
  305       <HR>
  306       <P>
  307         <A NAME="Trace">
  308          
  309         </A>
  310         <h2> Object: <em> Trace </em> </h2>
  311         <b>Class</b>: Object
  312         <BR>
  313         <b> Procs </b>
  314         <a href="#Trace-closeTraceFile">closeTraceFile</a>, <a href="#Trace-openTraceFile">openTraceFile</a>, <a href="#Trace-puts">puts</a>.
  315         <TABLE BORDER="0">
  316           <TR VALIGN="top">
  317             <TD VALIGN="top">
  318               <em> Description:</em>
  319             </TD>
  320             <TD VALIGN="top">
  321              
  322       Write trace outputs and produce statistics. Variable traceStream
  323       defines where to write trace output (default: stderr).
  324    
  325             </TD>
  326           </TR>
  327         </TABLE>
  328         <h3>Procs</h3>
  329         <UL>
  330           <LI>
  331             <A NAME="Trace-puts">
  332              
  333             </A>
  334             <b>puts </b>
  335             <em>line</em>
  336             <TABLE BORDER="0">
  337                         <TR VALIGN="top">
  338               <TD VALIGN="top">
  339                 <em>Arguments:</em>
  340               </TD>
  341               <TD VALIGN="top">
  342                 <b>line</b>: output line
  343               </TD>
  344             </TR>
  345  
  346               <TR VALIGN="top">
  347                 <TD VALIGN="top">
  348                   <em> Description:</em>
  349                 </TD>
  350                 <TD VALIGN="top">
  351                  
  352       Define how traceFilter writes to the output stream. Default:
  353       write to trace stream.
  354    
  355                 </TD>
  356               </TR>
  357             </TABLE>
  358           </LI>
  359           <LI>
  360             <A NAME="Trace-openTraceFile">
  361              
  362             </A>
  363             <b>openTraceFile </b>
  364             <em>name</em>
  365             <TABLE BORDER="0">
  366                         <TR VALIGN="top">
  367               <TD VALIGN="top">
  368                 <em>Arguments:</em>
  369               </TD>
  370               <TD VALIGN="top">
  371                 <b>name</b>: file name
  372               </TD>
  373             </TR>
  374  
  375               <TR VALIGN="top">
  376                 <TD VALIGN="top">
  377                   <em> Description:</em>
  378                 </TD>
  379                 <TD VALIGN="top">
  380                  
  381       Redirect trace output to file.
  382    
  383                 </TD>
  384               </TR>
  385             </TABLE>
  386           </LI>
  387           <LI>
  388             <A NAME="Trace-closeTraceFile">
  389              
  390             </A>
  391             <b>closeTraceFile </b>
  392             <em>name</em>
  393             <TABLE BORDER="0">
  394                         <TR VALIGN="top">
  395               <TD VALIGN="top">
  396                 <em>Arguments:</em>
  397               </TD>
  398               <TD VALIGN="top">
  399                 <b>name</b>: file name
  400               </TD>
  401             </TR>
  402  
  403               <TR VALIGN="top">
  404                 <TD VALIGN="top">
  405                   <em> Description:</em>
  406                 </TD>
  407                 <TD VALIGN="top">
  408                  
  409       Close trace  file and redirect output to stderr.
  410    
  411                 </TD>
  412               </TR>
  413             </TABLE>
  414           </LI>
  415         </UL>
  416       </P>
  417       <BR>
  418     </P>
  419     <HR>
  420     <P>
  421     </P>
  422     <A HREF="./index.html">
  423       Back to index page.
  424     </A>
  425     <BR>
  426     <HR>
  427     <P>
  428     </P>
  429   </BODY>
  430   </HTML>
  431