doc/api/python/log2xml-module.html
changeset 432 f2ddfa555b0f
equal deleted inserted replaced
431:7685cec9fd3c 432:f2ddfa555b0f
       
     1 <?xml version="1.0" encoding="ascii"?>
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3           "DTD/xhtml1-transitional.dtd">
       
     4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
       
     5 <head>
       
     6   <title>log2xml</title>
       
     7   <link rel="stylesheet" href="epydoc.css" type="text/css" />
       
     8   <script type="text/javascript" src="epydoc.js"></script>
       
     9 </head>
       
    10 
       
    11 <body bgcolor="white" text="black" link="blue" vlink="#204080"
       
    12       alink="#204080">
       
    13 <!-- ==================== NAVIGATION BAR ==================== -->
       
    14 <table class="navbar" border="0" width="100%" cellpadding="0"
       
    15        bgcolor="#a0c0ff" cellspacing="0">
       
    16   <tr valign="middle">
       
    17 
       
    18   <!-- Tree link -->
       
    19       <th>&nbsp;&nbsp;&nbsp;<a
       
    20         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
    21 
       
    22   <!-- Index link -->
       
    23       <th>&nbsp;&nbsp;&nbsp;<a
       
    24         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
    25 
       
    26   <!-- Help link -->
       
    27       <th>&nbsp;&nbsp;&nbsp;<a
       
    28         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
    29 
       
    30       <th class="navbar" width="100%"></th>
       
    31   </tr>
       
    32 </table>
       
    33 <table width="100%" cellpadding="0" cellspacing="0">
       
    34   <tr valign="top">
       
    35     <td width="100%">
       
    36       <span class="breadcrumbs">
       
    37         Module&nbsp;log2xml
       
    38       </span>
       
    39     </td>
       
    40     <td>
       
    41       <table cellpadding="0" cellspacing="0">
       
    42         <!-- hide/show private -->
       
    43         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    44     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    45         <tr><td align="right"><span class="options"
       
    46             >[<a href="frames.html" target="_top">frames</a
       
    47             >]&nbsp;|&nbsp;<a href="log2xml-module.html"
       
    48             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    49       </table>
       
    50     </td>
       
    51   </tr>
       
    52 </table>
       
    53 <!-- ==================== MODULE DESCRIPTION ==================== -->
       
    54 <h1 class="epydoc">Module log2xml</h1><span class="codelink"><a href="log2xml-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    55 Symbian log converter.<br /><br />
       
    56 
       
    57 <!-- ==================== CLASSES ==================== -->
       
    58 <a name="section-Classes"></a>
       
    59 <table class="summary" border="1" cellpadding="3"
       
    60        cellspacing="0" width="100%" bgcolor="white">
       
    61 <tr bgcolor="#70b0f0" class="table-header">
       
    62   <td colspan="2" class="table-header">
       
    63     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    64       <tr valign="top">
       
    65         <td align="left"><span class="table-header">Classes</span></td>
       
    66         <td align="right" valign="top"
       
    67          ><span class="options">[<a href="#section-Classes"
       
    68          class="privatelink" onclick="toggle_private();"
       
    69          >hide private</a>]</span></td>
       
    70       </tr>
       
    71     </table>
       
    72   </td>
       
    73 </tr>
       
    74 <tr>
       
    75     <td width="15%" align="right" valign="top" class="summary">
       
    76       <span class="summary-type">&nbsp;</span>
       
    77     </td><td class="summary">
       
    78         <a href="log2xml.Stack-class.html" class="summary-name">Stack</a><br />
       
    79       Bottomless stack.
       
    80     </td>
       
    81   </tr>
       
    82 <tr>
       
    83     <td width="15%" align="right" valign="top" class="summary">
       
    84       <span class="summary-type">&nbsp;</span>
       
    85     </td><td class="summary">
       
    86         <a href="log2xml.LogWriter-class.html" class="summary-name">LogWriter</a><br />
       
    87       XML Log writer.
       
    88     </td>
       
    89   </tr>
       
    90 <tr>
       
    91     <td width="15%" align="right" valign="top" class="summary">
       
    92       <span class="summary-type">&nbsp;</span>
       
    93     </td><td class="summary">
       
    94         <a href="log2xml.ContentWriter-class.html" class="summary-name">ContentWriter</a><br />
       
    95       SAX Content writer.
       
    96     </td>
       
    97   </tr>
       
    98 <tr>
       
    99     <td width="15%" align="right" valign="top" class="summary">
       
   100       <span class="summary-type">&nbsp;</span>
       
   101     </td><td class="summary">
       
   102         <a href="log2xml.AppendSummary-class.html" class="summary-name">AppendSummary</a><br />
       
   103       SAX content handler to add an XML log to the summary.
       
   104     </td>
       
   105   </tr>
       
   106 </table>
       
   107 <!-- ==================== FUNCTIONS ==================== -->
       
   108 <a name="section-Functions"></a>
       
   109 <table class="summary" border="1" cellpadding="3"
       
   110        cellspacing="0" width="100%" bgcolor="white">
       
   111 <tr bgcolor="#70b0f0" class="table-header">
       
   112   <td colspan="2" class="table-header">
       
   113     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   114       <tr valign="top">
       
   115         <td align="left"><span class="table-header">Functions</span></td>
       
   116         <td align="right" valign="top"
       
   117          ><span class="options">[<a href="#section-Functions"
       
   118          class="privatelink" onclick="toggle_private();"
       
   119          >hide private</a>]</span></td>
       
   120       </tr>
       
   121     </table>
       
   122   </td>
       
   123 </tr>
       
   124 <tr>
       
   125     <td width="15%" align="right" valign="top" class="summary">
       
   126       <span class="summary-type">&nbsp;</span>
       
   127     </td><td class="summary">
       
   128       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   129         <tr>
       
   130           <td><span class="summary-sig"><a name="find_priority"></a><span class="summary-sig-name">find_priority</span>(<span class="summary-sig-arg">line</span>,
       
   131         <span class="summary-sig-arg">config</span>)</span></td>
       
   132           <td align="right" valign="top">
       
   133             <span class="codelink"><a href="log2xml-pysrc.html#find_priority">source&nbsp;code</a></span>
       
   134             
       
   135           </td>
       
   136         </tr>
       
   137       </table>
       
   138       
       
   139     </td>
       
   140   </tr>
       
   141 <tr>
       
   142     <td width="15%" align="right" valign="top" class="summary">
       
   143       <span class="summary-type">&nbsp;</span>
       
   144     </td><td class="summary">
       
   145       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   146         <tr>
       
   147           <td><span class="summary-sig"><a href="log2xml-module.html#to_cdata" class="summary-sig-name">to_cdata</a>(<span class="summary-sig-arg">text</span>)</span><br />
       
   148       Cleanup string to match CDATA requiements.</td>
       
   149           <td align="right" valign="top">
       
   150             <span class="codelink"><a href="log2xml-pysrc.html#to_cdata">source&nbsp;code</a></span>
       
   151             
       
   152           </td>
       
   153         </tr>
       
   154       </table>
       
   155       
       
   156     </td>
       
   157   </tr>
       
   158 <tr>
       
   159     <td width="15%" align="right" valign="top" class="summary">
       
   160       <span class="summary-type">&nbsp;</span>
       
   161     </td><td class="summary">
       
   162       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   163         <tr>
       
   164           <td><span class="summary-sig"><a name="convert"></a><span class="summary-sig-name">convert</span>(<span class="summary-sig-arg">inputfile</span>,
       
   165         <span class="summary-sig-arg">outputfile</span>,
       
   166         <span class="summary-sig-arg">fulllogging</span>=<span class="summary-sig-default">True</span>,
       
   167         <span class="summary-sig-arg">configuration</span>=<span class="summary-sig-default">DEFAULT_CONFIGURATION</span>)</span><br />
       
   168       Convert an input log into an XML log and write an outputfile.</td>
       
   169           <td align="right" valign="top">
       
   170             <span class="codelink"><a href="log2xml-pysrc.html#convert">source&nbsp;code</a></span>
       
   171             
       
   172           </td>
       
   173         </tr>
       
   174       </table>
       
   175       
       
   176     </td>
       
   177   </tr>
       
   178 <tr>
       
   179     <td width="15%" align="right" valign="top" class="summary">
       
   180       <span class="summary-type">&nbsp;</span>
       
   181     </td><td class="summary">
       
   182       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   183         <tr>
       
   184           <td><span class="summary-sig"><a name="convert_old"></a><span class="summary-sig-name">convert_old</span>(<span class="summary-sig-arg">inputfile</span>,
       
   185         <span class="summary-sig-arg">outputfile</span>,
       
   186         <span class="summary-sig-arg">fulllogging</span>=<span class="summary-sig-default">True</span>,
       
   187         <span class="summary-sig-arg">configuration</span>=<span class="summary-sig-default">DEFAULT_CONFIGURATION</span>)</span><br />
       
   188       Convert an input log into an XML log and write an outputfile.</td>
       
   189           <td align="right" valign="top">
       
   190             <span class="codelink"><a href="log2xml-pysrc.html#convert_old">source&nbsp;code</a></span>
       
   191             
       
   192           </td>
       
   193         </tr>
       
   194       </table>
       
   195       
       
   196     </td>
       
   197   </tr>
       
   198 <tr>
       
   199     <td width="15%" align="right" valign="top" class="summary">
       
   200       <span class="summary-type">&nbsp;</span>
       
   201     </td><td class="summary">
       
   202       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   203         <tr>
       
   204           <td><span class="summary-sig"><a name="append_summary"></a><span class="summary-sig-name">append_summary</span>(<span class="summary-sig-arg">summary</span>,
       
   205         <span class="summary-sig-arg">xmllog</span>,
       
   206         <span class="summary-sig-arg">maxmb</span>=<span class="summary-sig-default">80</span>)</span><br />
       
   207       Append content to the summary xml file.</td>
       
   208           <td align="right" valign="top">
       
   209             <span class="codelink"><a href="log2xml-pysrc.html#append_summary">source&nbsp;code</a></span>
       
   210             
       
   211           </td>
       
   212         </tr>
       
   213       </table>
       
   214       
       
   215     </td>
       
   216   </tr>
       
   217 <tr>
       
   218     <td width="15%" align="right" valign="top" class="summary">
       
   219       <span class="summary-type">&nbsp;</span>
       
   220     </td><td class="summary">
       
   221       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   222         <tr>
       
   223           <td><span class="summary-sig"><a name="symbian_log_header"></a><span class="summary-sig-name">symbian_log_header</span>(<span class="summary-sig-arg">output</span>,
       
   224         <span class="summary-sig-arg">config</span>,
       
   225         <span class="summary-sig-arg">command</span>,
       
   226         <span class="summary-sig-arg">dir</span>)</span></td>
       
   227           <td align="right" valign="top">
       
   228             <span class="codelink"><a href="log2xml-pysrc.html#symbian_log_header">source&nbsp;code</a></span>
       
   229             
       
   230           </td>
       
   231         </tr>
       
   232       </table>
       
   233       
       
   234     </td>
       
   235   </tr>
       
   236 <tr>
       
   237     <td width="15%" align="right" valign="top" class="summary">
       
   238       <span class="summary-type">&nbsp;</span>
       
   239     </td><td class="summary">
       
   240       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   241         <tr>
       
   242           <td><span class="summary-sig"><a name="symbian_log_footer"></a><span class="summary-sig-name">symbian_log_footer</span>(<span class="summary-sig-arg">output</span>)</span></td>
       
   243           <td align="right" valign="top">
       
   244             <span class="codelink"><a href="log2xml-pysrc.html#symbian_log_footer">source&nbsp;code</a></span>
       
   245             
       
   246           </td>
       
   247         </tr>
       
   248       </table>
       
   249       
       
   250     </td>
       
   251   </tr>
       
   252 </table>
       
   253 <!-- ==================== VARIABLES ==================== -->
       
   254 <a name="section-Variables"></a>
       
   255 <table class="summary" border="1" cellpadding="3"
       
   256        cellspacing="0" width="100%" bgcolor="white">
       
   257 <tr bgcolor="#70b0f0" class="table-header">
       
   258   <td colspan="2" class="table-header">
       
   259     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   260       <tr valign="top">
       
   261         <td align="left"><span class="table-header">Variables</span></td>
       
   262         <td align="right" valign="top"
       
   263          ><span class="options">[<a href="#section-Variables"
       
   264          class="privatelink" onclick="toggle_private();"
       
   265          >hide private</a>]</span></td>
       
   266       </tr>
       
   267     </table>
       
   268   </td>
       
   269 </tr>
       
   270 <tr>
       
   271     <td width="15%" align="right" valign="top" class="summary">
       
   272       <span class="summary-type">&nbsp;</span>
       
   273     </td><td class="summary">
       
   274         <a href="log2xml-module.html#DEFAULT_CONFIGURATION" class="summary-name">DEFAULT_CONFIGURATION</a> = <code title="{&quot;FATAL&quot;: [r&quot;mingw_make.exe&quot;], &quot;ERROR&quot;: [r'^(?:(?:\s*\d+\)\s*)|(?:\s*\\
       
   275 *\*\*\s*))ERROR:', r&quot;^MISSING:&quot;, r&quot;Error:\s+&quot;, r&quot;^Error:&quot;, r&quot;'.+' is n\
       
   276 ot recognized as an internal or external command&quot;, r&quot;FLEXlm error:&quot;, r\
       
   277 &quot;(ABLD|BLDMAKE) ERROR:&quot;, r&quot;FATAL ERROR\(S\):&quot;, r&quot;fatal error U1077&quot;, r\
       
   278 &quot;warning U4010&quot;, r&quot;^make(?:\[\d+\])?\: \*\*\*&quot;, r&quot;^make(?:\[\d+\])?:\s\
       
   279 +.*\s+not\s+remade&quot;, r&quot;\&quot;(.*)\&quot;, line (\d+): (Error: +(.\d+.*?):.*)$&quot;,\
       
   280  r&quot;error: ((Internal fault):.*)$&quot;, r&quot;Exception: [A-Z0-9_]+&quot;, r&quot;target \
       
   281 .* given more than once in the same rule&quot;, r&quot;^ERROR:&quot;, r&quot;^ERROR EC\d+:\
       
   282 ...">{&quot;FATAL&quot;: [r&quot;mingw_make.exe&quot;], &quot;ERROR&quot;<code class="variable-ellipsis">...</code></code>
       
   283     </td>
       
   284   </tr>
       
   285 </table>
       
   286 <!-- ==================== FUNCTION DETAILS ==================== -->
       
   287 <a name="section-FunctionDetails"></a>
       
   288 <table class="details" border="1" cellpadding="3"
       
   289        cellspacing="0" width="100%" bgcolor="white">
       
   290 <tr bgcolor="#70b0f0" class="table-header">
       
   291   <td colspan="2" class="table-header">
       
   292     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   293       <tr valign="top">
       
   294         <td align="left"><span class="table-header">Function Details</span></td>
       
   295         <td align="right" valign="top"
       
   296          ><span class="options">[<a href="#section-FunctionDetails"
       
   297          class="privatelink" onclick="toggle_private();"
       
   298          >hide private</a>]</span></td>
       
   299       </tr>
       
   300     </table>
       
   301   </td>
       
   302 </tr>
       
   303 </table>
       
   304 <a name="to_cdata"></a>
       
   305 <div>
       
   306 <table class="details" border="1" cellpadding="3"
       
   307        cellspacing="0" width="100%" bgcolor="white">
       
   308 <tr><td>
       
   309   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   310   <tr valign="top"><td>
       
   311   <h3 class="epydoc"><span class="sig"><span class="sig-name">to_cdata</span>(<span class="sig-arg">text</span>)</span>
       
   312   </h3>
       
   313   </td><td align="right" valign="top"
       
   314     ><span class="codelink"><a href="log2xml-pysrc.html#to_cdata">source&nbsp;code</a></span>&nbsp;
       
   315     </td>
       
   316   </table>
       
   317   
       
   318   Cleanup string to match CDATA requiements.
       
   319 These are the only allowed characters: #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF].
       
   320   <dl class="fields">
       
   321   </dl>
       
   322 </td></tr></table>
       
   323 </div>
       
   324 <br />
       
   325 <!-- ==================== VARIABLES DETAILS ==================== -->
       
   326 <a name="section-VariablesDetails"></a>
       
   327 <table class="details" border="1" cellpadding="3"
       
   328        cellspacing="0" width="100%" bgcolor="white">
       
   329 <tr bgcolor="#70b0f0" class="table-header">
       
   330   <td colspan="2" class="table-header">
       
   331     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   332       <tr valign="top">
       
   333         <td align="left"><span class="table-header">Variables Details</span></td>
       
   334         <td align="right" valign="top"
       
   335          ><span class="options">[<a href="#section-VariablesDetails"
       
   336          class="privatelink" onclick="toggle_private();"
       
   337          >hide private</a>]</span></td>
       
   338       </tr>
       
   339     </table>
       
   340   </td>
       
   341 </tr>
       
   342 </table>
       
   343 <a name="DEFAULT_CONFIGURATION"></a>
       
   344 <div>
       
   345 <table class="details" border="1" cellpadding="3"
       
   346        cellspacing="0" width="100%" bgcolor="white">
       
   347 <tr><td>
       
   348   <h3 class="epydoc">DEFAULT_CONFIGURATION</h3>
       
   349   
       
   350   <dl class="fields">
       
   351   </dl>
       
   352   <dl class="fields">
       
   353     <dt>Value:</dt>
       
   354       <dd><table><tr><td><pre class="variable">
       
   355 {&quot;FATAL&quot;: [r&quot;mingw_make.exe&quot;], &quot;ERROR&quot;: [r'^(?:(?:\s*\d+\)\s*)|(?:\s*\<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   356 *\*\*\s*))ERROR:', r&quot;^MISSING:&quot;, r&quot;Error:\s+&quot;, r&quot;^Error:&quot;, r&quot;'.+' is n<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   357 ot recognized as an internal or external command&quot;, r&quot;FLEXlm error:&quot;, r<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   358 &quot;(ABLD|BLDMAKE) ERROR:&quot;, r&quot;FATAL ERROR\(S\):&quot;, r&quot;fatal error U1077&quot;, r<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   359 &quot;warning U4010&quot;, r&quot;^make(?:\[\d+\])?\: \*\*\*&quot;, r&quot;^make(?:\[\d+\])?:\s<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   360 +.*\s+not\s+remade&quot;, r&quot;\&quot;(.*)\&quot;, line (\d+): (Error: +(.\d+.*?):.*)$&quot;,<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   361  r&quot;error: ((Internal fault):.*)$&quot;, r&quot;Exception: [A-Z0-9_]+&quot;, r&quot;target <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   362 .* given more than once in the same rule&quot;, r&quot;^ERROR:&quot;, r&quot;^ERROR EC\d+:<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
       
   363 <code class="variable-ellipsis">...</code>
       
   364 </pre></td></tr></table>
       
   365 </dd>
       
   366   </dl>
       
   367 </td></tr></table>
       
   368 </div>
       
   369 <br />
       
   370 <!-- ==================== NAVIGATION BAR ==================== -->
       
   371 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   372        bgcolor="#a0c0ff" cellspacing="0">
       
   373   <tr valign="middle">
       
   374 
       
   375   <!-- Tree link -->
       
   376       <th>&nbsp;&nbsp;&nbsp;<a
       
   377         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   378 
       
   379   <!-- Index link -->
       
   380       <th>&nbsp;&nbsp;&nbsp;<a
       
   381         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   382 
       
   383   <!-- Help link -->
       
   384       <th>&nbsp;&nbsp;&nbsp;<a
       
   385         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   386 
       
   387       <th class="navbar" width="100%"></th>
       
   388   </tr>
       
   389 </table>
       
   390 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   391   <tr>
       
   392     <td align="left" class="footer">
       
   393     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
       
   394     </td>
       
   395     <td align="right" class="footer">
       
   396       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   397     </td>
       
   398   </tr>
       
   399 </table>
       
   400 
       
   401 <script type="text/javascript">
       
   402   <!--
       
   403   // Private objects are initially displayed (because if
       
   404   // javascript is turned off then we want them to be
       
   405   // visible); but by default, we want to hide them.  So hide
       
   406   // them unless we have a cookie that says to show them.
       
   407   checkCookie()
       
   408   // -->
       
   409 </script>
       
   410   
       
   411 </body>
       
   412 </html>