doc/api/python/log2xml-module.html
author Simon Howkins <simonh@symbian.org>
Mon, 12 Oct 2009 15:07:06 +0100
changeset 654 b64b5a0f8662
parent 432 f2ddfa555b0f
permissions -rw-r--r--
Added lib dir to pick up Text::CSV when it's not included with the installed perl distribution.

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>log2xml</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        Module&nbsp;log2xml
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="log2xml-module.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== MODULE DESCRIPTION ==================== -->
<h1 class="epydoc">Module log2xml</h1><span class="codelink"><a href="log2xml-pysrc.html">source&nbsp;code</a></span><br /><br />
Symbian log converter.<br /><br />

<!-- ==================== CLASSES ==================== -->
<a name="section-Classes"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Classes</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Classes"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="log2xml.Stack-class.html" class="summary-name">Stack</a><br />
      Bottomless stack.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="log2xml.LogWriter-class.html" class="summary-name">LogWriter</a><br />
      XML Log writer.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="log2xml.ContentWriter-class.html" class="summary-name">ContentWriter</a><br />
      SAX Content writer.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="log2xml.AppendSummary-class.html" class="summary-name">AppendSummary</a><br />
      SAX content handler to add an XML log to the summary.
    </td>
  </tr>
</table>
<!-- ==================== FUNCTIONS ==================== -->
<a name="section-Functions"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Functions</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Functions"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">config</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="log2xml-pysrc.html#find_priority">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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 />
      Cleanup string to match CDATA requiements.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="log2xml-pysrc.html#to_cdata">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="convert"></a><span class="summary-sig-name">convert</span>(<span class="summary-sig-arg">inputfile</span>,
        <span class="summary-sig-arg">outputfile</span>,
        <span class="summary-sig-arg">fulllogging</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">configuration</span>=<span class="summary-sig-default">DEFAULT_CONFIGURATION</span>)</span><br />
      Convert an input log into an XML log and write an outputfile.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="log2xml-pysrc.html#convert">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">outputfile</span>,
        <span class="summary-sig-arg">fulllogging</span>=<span class="summary-sig-default">True</span>,
        <span class="summary-sig-arg">configuration</span>=<span class="summary-sig-default">DEFAULT_CONFIGURATION</span>)</span><br />
      Convert an input log into an XML log and write an outputfile.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="log2xml-pysrc.html#convert_old">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">xmllog</span>,
        <span class="summary-sig-arg">maxmb</span>=<span class="summary-sig-default">80</span>)</span><br />
      Append content to the summary xml file.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="log2xml-pysrc.html#append_summary">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>,
        <span class="summary-sig-arg">config</span>,
        <span class="summary-sig-arg">command</span>,
        <span class="summary-sig-arg">dir</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="log2xml-pysrc.html#symbian_log_header">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <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>
          <td align="right" valign="top">
            <span class="codelink"><a href="log2xml-pysrc.html#symbian_log_footer">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== VARIABLES ==================== -->
<a name="section-Variables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Variables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <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*\\
*\*\*\s*))ERROR:', r&quot;^MISSING:&quot;, r&quot;Error:\s+&quot;, r&quot;^Error:&quot;, r&quot;'.+' is n\
ot recognized as an internal or external command&quot;, r&quot;FLEXlm error:&quot;, r\
&quot;(ABLD|BLDMAKE) ERROR:&quot;, r&quot;FATAL ERROR\(S\):&quot;, r&quot;fatal error U1077&quot;, r\
&quot;warning U4010&quot;, r&quot;^make(?:\[\d+\])?\: \*\*\*&quot;, r&quot;^make(?:\[\d+\])?:\s\
+.*\s+not\s+remade&quot;, r&quot;\&quot;(.*)\&quot;, line (\d+): (Error: +(.\d+.*?):.*)$&quot;,\
 r&quot;error: ((Internal fault):.*)$&quot;, r&quot;Exception: [A-Z0-9_]+&quot;, r&quot;target \
.* given more than once in the same rule&quot;, r&quot;^ERROR:&quot;, r&quot;^ERROR EC\d+:\
...">{&quot;FATAL&quot;: [r&quot;mingw_make.exe&quot;], &quot;ERROR&quot;<code class="variable-ellipsis">...</code></code>
    </td>
  </tr>
</table>
<!-- ==================== FUNCTION DETAILS ==================== -->
<a name="section-FunctionDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Function Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-FunctionDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="to_cdata"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">to_cdata</span>(<span class="sig-arg">text</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="log2xml-pysrc.html#to_cdata">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  Cleanup string to match CDATA requiements.
These are the only allowed characters: #x9 | #xA | #xD | [#x20-#xD7FF] | [#xE000-#xFFFD] | [#x10000-#x10FFFF].
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Variables Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-VariablesDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="DEFAULT_CONFIGURATION"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">DEFAULT_CONFIGURATION</h3>
  
  <dl class="fields">
  </dl>
  <dl class="fields">
    <dt>Value:</dt>
      <dd><table><tr><td><pre class="variable">
{&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>
*\*\*\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>
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>
&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>
&quot;warning U4010&quot;, r&quot;^make(?:\[\d+\])?\: \*\*\*&quot;, r&quot;^make(?:\[\d+\])?:\s<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
+.*\s+not\s+remade&quot;, r&quot;\&quot;(.*)\&quot;, line (\d+): (Error: +(.\d+.*?):.*)$&quot;,<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
 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>
.* 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>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
    </td>
    <td align="right" class="footer">
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie()
  // -->
</script>
  
</body>
</html>