doc/api/python/ats3.parsers.MmpFileParser-class.html
author Simon Howkins <simonh@symbian.org>
Thu, 01 Oct 2009 17:21:32 +0100
changeset 569 5af7cc0d44a1
parent 432 f2ddfa555b0f
permissions -rw-r--r--
Adfjusted XML format used, so there's a document-level tag - <buildStatus> which can wrap multiple <phase> tags.

<?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>ats3.parsers.MmpFileParser</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">
        <a href="ats3-module.html">Package&nbsp;ats3</a> ::
        <a href="ats3.parsers-module.html">Module&nbsp;parsers</a> ::
        Class&nbsp;MmpFileParser
      </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="ats3.parsers.MmpFileParser-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class MmpFileParser</h1><span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser">source&nbsp;code</a></span><br /><br />
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">MmpFileParser</strong>
</pre>

<hr />
Parser for .mmp files. Returns wanted information from the mmp-file
- file type (executable dll, plugin, exe, etc)
- test harness (STIF, EUNIT) if mmp is related to the test component
- file name
- libraries listed in the mmp<br /><br />

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></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">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         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 href="ats3.parsers.MmpFileParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
      x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.__init__">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="ats3.parsers.MmpFileParser-class.html#get_target_filetype" class="summary-sig-name">get_target_filetype</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path_to_mmp</span>=<span class="summary-sig-default">None</span>)</span><br />
      Filetype given using TARGETTYPE in .mmp file is returned.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_target_filetype">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="ats3.parsers.MmpFileParser-class.html#get_target_filename" class="summary-sig-name">get_target_filename</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path_to_mmp</span>=<span class="summary-sig-default">None</span>)</span><br />
      Filename given using TARGET in .mmp file is returned
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_target_filename(&quot;c:path    ommp&quot;)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_target_filename">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="ats3.parsers.MmpFileParser-class.html#get_libraries" class="summary-sig-name">get_libraries</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path_to_mmp</span>=<span class="summary-sig-default">None</span>)</span><br />
      Libraries listed in the MMP file are returned in a list
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_libraries(&quot;c:path  ommp&quot;)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_libraries">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="ats3.parsers.MmpFileParser-class.html#get_harness" class="summary-sig-name">get_harness</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path_to_mmp</span>=<span class="summary-sig-default">None</span>)</span><br />
      Returns harness of test component
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_harness(&quot;c:path    ommp&quot;)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_harness">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="ats3.parsers.MmpFileParser-class.html#get_dll_type" class="summary-sig-name">get_dll_type</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path_to_mmp</span>=<span class="summary-sig-default">None</span>)</span><br />
      Returns type of test whether 'executable' or 'dependent' (dependent can be a stub or plugin)
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_dll_type(&quot;c:path   ommp&quot;)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_dll_type">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="read_information_from_mmp"></a><span class="summary-sig-name">read_information_from_mmp</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">path_to_mmp</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">flag</span>=<span class="summary-sig-default">0</span>)</span><br />
      Returns wanted information - user can define
the wanted information level by setting a flag
value following way:
0 - (targetfilename, filetype, libraries, harness)
1 - (targetfilename, filetype, libraries)
2 - (targetfilename, filetype)
3 - targetfilename
4 - filetype
5 - libraries
6 - harness (in case of test component)
7 - mmpfilename</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.read_information_from_mmp">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></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">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></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">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  x.__init__(...) initializes x; see x.__class__.__doc__ for signature
  <dl class="fields">
    <dt>Overrides:
      object.__init__
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="get_target_filetype"></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">get_target_filetype</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path_to_mmp</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_target_filetype">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Filetype given using TARGETTYPE in .mmp file is returned.
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_target_filetype(&quot;c:path    ommp&quot;)</p>
<p>if mmp file is not given, the function will try to find the file(s) on the given location with extension &quot;.mmp&quot;</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_target_filename"></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">get_target_filename</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path_to_mmp</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_target_filename">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Filename given using TARGET in .mmp file is returned
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_target_filename(&quot;c:path    ommp&quot;)</p>
<p>if mmp file is not given, the function will try to find the file(s) on the given location with extension &quot;.mmp&quot;</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_libraries"></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">get_libraries</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path_to_mmp</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_libraries">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Libraries listed in the MMP file are returned in a list
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_libraries(&quot;c:path  ommp&quot;)</p>
<p>if mmp file is not given, the function will try to find the file(s) on the given location with extension &quot;.mmp&quot;</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_harness"></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">get_harness</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path_to_mmp</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_harness">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Returns harness of test component
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_harness(&quot;c:path    ommp&quot;)</p>
<p>if mmp file is not given, the function will try to find the file(s) on the given location with extension &quot;.mmp&quot;</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_dll_type"></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">get_dll_type</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">path_to_mmp</span>=<span class="sig-default">None</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="ats3.parsers-pysrc.html#MmpFileParser.get_dll_type">source&nbsp;code</a></span>&nbsp;
    </td>
  </table>
  
  <p>Returns type of test whether 'executable' or 'dependent' (dependent can be a stub or plugin)
If &quot;c:path     ommp&quot; is a location where mmp file is stored
get_dll_type(&quot;c:path   ommp&quot;)</p>
<p>if mmp file is not given, the function will try to find the file(s) on the given location with extension &quot;.mmp&quot;</p>
  <dl class="fields">
  </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:17 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>