doc/api/python/ats3.parsers.BldFileParser-class.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>ats3.parsers.BldFileParser</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         <a href="ats3-module.html">Package&nbsp;ats3</a> ::
       
    38         <a href="ats3.parsers-module.html">Module&nbsp;parsers</a> ::
       
    39         Class&nbsp;BldFileParser
       
    40       </span>
       
    41     </td>
       
    42     <td>
       
    43       <table cellpadding="0" cellspacing="0">
       
    44         <!-- hide/show private -->
       
    45         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    46     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    47         <tr><td align="right"><span class="options"
       
    48             >[<a href="frames.html" target="_top">frames</a
       
    49             >]&nbsp;|&nbsp;<a href="ats3.parsers.BldFileParser-class.html"
       
    50             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    51       </table>
       
    52     </td>
       
    53   </tr>
       
    54 </table>
       
    55 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    56 <h1 class="epydoc">Class BldFileParser</h1><span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser">source&nbsp;code</a></span><br /><br />
       
    57 <pre class="base-tree">
       
    58 object --+
       
    59          |
       
    60         <strong class="uidshort">BldFileParser</strong>
       
    61 </pre>
       
    62 
       
    63 <hr />
       
    64 Parser for bld.inf files. Returns MACRO values.
       
    65 Parsing Paths can be done using CPP parser<br /><br />
       
    66 
       
    67 <!-- ==================== INSTANCE METHODS ==================== -->
       
    68 <a name="section-InstanceMethods"></a>
       
    69 <table class="summary" border="1" cellpadding="3"
       
    70        cellspacing="0" width="100%" bgcolor="white">
       
    71 <tr bgcolor="#70b0f0" class="table-header">
       
    72   <td colspan="2" class="table-header">
       
    73     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    74       <tr valign="top">
       
    75         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    76         <td align="right" valign="top"
       
    77          ><span class="options">[<a href="#section-InstanceMethods"
       
    78          class="privatelink" onclick="toggle_private();"
       
    79          >hide private</a>]</span></td>
       
    80       </tr>
       
    81     </table>
       
    82   </td>
       
    83 </tr>
       
    84 <tr>
       
    85     <td width="15%" align="right" valign="top" class="summary">
       
    86       <span class="summary-type">&nbsp;</span>
       
    87     </td><td class="summary">
       
    88       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    89         <tr>
       
    90           <td><span class="summary-sig"><a href="ats3.parsers.BldFileParser-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>)</span><br />
       
    91       x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td>
       
    92           <td align="right" valign="top">
       
    93             <span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser.__init__">source&nbsp;code</a></span>
       
    94             
       
    95           </td>
       
    96         </tr>
       
    97       </table>
       
    98       
       
    99     </td>
       
   100   </tr>
       
   101 <tr>
       
   102     <td width="15%" align="right" valign="top" class="summary">
       
   103       <span class="summary-type">&nbsp;</span>
       
   104     </td><td class="summary">
       
   105       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   106         <tr>
       
   107           <td><span class="summary-sig"><a href="ats3.parsers.BldFileParser-class.html#get_test_mmp_files" class="summary-sig-name">get_test_mmp_files</a>(<span class="summary-sig-arg">self</span>,
       
   108         <span class="summary-sig-arg">bld_file_path</span>=<span class="summary-sig-default">None</span>,
       
   109         <span class="summary-sig-arg">with_full_path</span>=<span class="summary-sig-default">True</span>)</span><br />
       
   110       returns a list of test mmp files
       
   111 Usage: if &quot;x:bcldfile&quot;, &quot;PRJ_TESTMMPFILES&quot;.</td>
       
   112           <td align="right" valign="top">
       
   113             <span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser.get_test_mmp_files">source&nbsp;code</a></span>
       
   114             
       
   115           </td>
       
   116         </tr>
       
   117       </table>
       
   118       
       
   119     </td>
       
   120   </tr>
       
   121 <tr>
       
   122     <td width="15%" align="right" valign="top" class="summary">
       
   123       <span class="summary-type">&nbsp;</span>
       
   124     </td><td class="summary">
       
   125       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   126         <tr>
       
   127           <td><span class="summary-sig"><a name="get_files"></a><span class="summary-sig-name">get_files</span>(<span class="summary-sig-arg">self</span>,
       
   128         <span class="summary-sig-arg">bld_inf_path</span>,
       
   129         <span class="summary-sig-arg">bld_macro</span>,
       
   130         <span class="summary-sig-arg">with_full_path</span>=<span class="summary-sig-default">True</span>)</span><br />
       
   131       Component's MMP files, as stored in BLD.INF.</td>
       
   132           <td align="right" valign="top">
       
   133             <span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser.get_files">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="ats3.parsers.BldFileParser-class.html#ignore_comments_from_input" class="summary-sig-name">ignore_comments_from_input</a>(<span class="summary-sig-arg">self</span>,
       
   148         <span class="summary-sig-arg">input_str</span>=<span class="summary-sig-default">&quot;&quot;</span>)</span><br />
       
   149       Removes comments from the input string.</td>
       
   150           <td align="right" valign="top">
       
   151             <span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser.ignore_comments_from_input">source&nbsp;code</a></span>
       
   152             
       
   153           </td>
       
   154         </tr>
       
   155       </table>
       
   156       
       
   157     </td>
       
   158   </tr>
       
   159   <tr>
       
   160     <td colspan="2" class="summary">
       
   161     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   162       <code>__delattr__</code>,
       
   163       <code>__getattribute__</code>,
       
   164       <code>__hash__</code>,
       
   165       <code>__new__</code>,
       
   166       <code>__reduce__</code>,
       
   167       <code>__reduce_ex__</code>,
       
   168       <code>__repr__</code>,
       
   169       <code>__setattr__</code>,
       
   170       <code>__str__</code>
       
   171       </p>
       
   172     </td>
       
   173   </tr>
       
   174 </table>
       
   175 <!-- ==================== PROPERTIES ==================== -->
       
   176 <a name="section-Properties"></a>
       
   177 <table class="summary" border="1" cellpadding="3"
       
   178        cellspacing="0" width="100%" bgcolor="white">
       
   179 <tr bgcolor="#70b0f0" class="table-header">
       
   180   <td colspan="2" class="table-header">
       
   181     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   182       <tr valign="top">
       
   183         <td align="left"><span class="table-header">Properties</span></td>
       
   184         <td align="right" valign="top"
       
   185          ><span class="options">[<a href="#section-Properties"
       
   186          class="privatelink" onclick="toggle_private();"
       
   187          >hide private</a>]</span></td>
       
   188       </tr>
       
   189     </table>
       
   190   </td>
       
   191 </tr>
       
   192   <tr>
       
   193     <td colspan="2" class="summary">
       
   194     <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
       
   195       <code>__class__</code>
       
   196       </p>
       
   197     </td>
       
   198   </tr>
       
   199 </table>
       
   200 <!-- ==================== METHOD DETAILS ==================== -->
       
   201 <a name="section-MethodDetails"></a>
       
   202 <table class="details" border="1" cellpadding="3"
       
   203        cellspacing="0" width="100%" bgcolor="white">
       
   204 <tr bgcolor="#70b0f0" class="table-header">
       
   205   <td colspan="2" class="table-header">
       
   206     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   207       <tr valign="top">
       
   208         <td align="left"><span class="table-header">Method Details</span></td>
       
   209         <td align="right" valign="top"
       
   210          ><span class="options">[<a href="#section-MethodDetails"
       
   211          class="privatelink" onclick="toggle_private();"
       
   212          >hide private</a>]</span></td>
       
   213       </tr>
       
   214     </table>
       
   215   </td>
       
   216 </tr>
       
   217 </table>
       
   218 <a name="__init__"></a>
       
   219 <div>
       
   220 <table class="details" border="1" cellpadding="3"
       
   221        cellspacing="0" width="100%" bgcolor="white">
       
   222 <tr><td>
       
   223   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   224   <tr valign="top"><td>
       
   225   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>)</span>
       
   226     <br /><em class="fname">(Constructor)</em>
       
   227   </h3>
       
   228   </td><td align="right" valign="top"
       
   229     ><span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser.__init__">source&nbsp;code</a></span>&nbsp;
       
   230     </td>
       
   231   </table>
       
   232   
       
   233   x.__init__(...) initializes x; see x.__class__.__doc__ for signature
       
   234   <dl class="fields">
       
   235     <dt>Overrides:
       
   236       object.__init__
       
   237         <dd><em class="note">(inherited documentation)</em></dd>
       
   238     </dt>
       
   239   </dl>
       
   240 </td></tr></table>
       
   241 </div>
       
   242 <a name="get_test_mmp_files"></a>
       
   243 <div>
       
   244 <table class="details" border="1" cellpadding="3"
       
   245        cellspacing="0" width="100%" bgcolor="white">
       
   246 <tr><td>
       
   247   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   248   <tr valign="top"><td>
       
   249   <h3 class="epydoc"><span class="sig"><span class="sig-name">get_test_mmp_files</span>(<span class="sig-arg">self</span>,
       
   250         <span class="sig-arg">bld_file_path</span>=<span class="sig-default">None</span>,
       
   251         <span class="sig-arg">with_full_path</span>=<span class="sig-default">True</span>)</span>
       
   252   </h3>
       
   253   </td><td align="right" valign="top"
       
   254     ><span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser.get_test_mmp_files">source&nbsp;code</a></span>&nbsp;
       
   255     </td>
       
   256   </table>
       
   257   
       
   258   <p>returns a list of test mmp files
       
   259 Usage: if &quot;x:bcldfile&quot;, &quot;PRJ_TESTMMPFILES&quot;.
       
   260 1. get_test_mmp_files(&quot;x:bcldfile&quot;) - with full paths e.g. [&quot;x:bcbc.mmp&quot;]
       
   261 2. get_test_mmp_files(&quot;x:bcldfile&quot;, False) - without full paths e.g. [&quot;abc.mmp&quot;]</p>
       
   262 <p>if bld file is not given, the function will try to find the file(s) on the given location with extension &quot;.inf&quot;</p>
       
   263   <dl class="fields">
       
   264   </dl>
       
   265 </td></tr></table>
       
   266 </div>
       
   267 <a name="ignore_comments_from_input"></a>
       
   268 <div>
       
   269 <table class="details" border="1" cellpadding="3"
       
   270        cellspacing="0" width="100%" bgcolor="white">
       
   271 <tr><td>
       
   272   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   273   <tr valign="top"><td>
       
   274   <h3 class="epydoc"><span class="sig"><span class="sig-name">ignore_comments_from_input</span>(<span class="sig-arg">self</span>,
       
   275         <span class="sig-arg">input_str</span>=<span class="sig-default">&quot;&quot;</span>)</span>
       
   276   </h3>
       
   277   </td><td align="right" valign="top"
       
   278     ><span class="codelink"><a href="ats3.parsers-pysrc.html#BldFileParser.ignore_comments_from_input">source&nbsp;code</a></span>&nbsp;
       
   279     </td>
       
   280   </table>
       
   281   
       
   282   Removes comments from the input string. Enables the use of examples
       
   283 in bld.inf.
       
   284   <dl class="fields">
       
   285   </dl>
       
   286 </td></tr></table>
       
   287 </div>
       
   288 <br />
       
   289 <!-- ==================== NAVIGATION BAR ==================== -->
       
   290 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   291        bgcolor="#a0c0ff" cellspacing="0">
       
   292   <tr valign="middle">
       
   293 
       
   294   <!-- Tree link -->
       
   295       <th>&nbsp;&nbsp;&nbsp;<a
       
   296         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   297 
       
   298   <!-- Index link -->
       
   299       <th>&nbsp;&nbsp;&nbsp;<a
       
   300         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   301 
       
   302   <!-- Help link -->
       
   303       <th>&nbsp;&nbsp;&nbsp;<a
       
   304         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   305 
       
   306       <th class="navbar" width="100%"></th>
       
   307   </tr>
       
   308 </table>
       
   309 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   310   <tr>
       
   311     <td align="left" class="footer">
       
   312     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   313     </td>
       
   314     <td align="right" class="footer">
       
   315       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   316     </td>
       
   317   </tr>
       
   318 </table>
       
   319 
       
   320 <script type="text/javascript">
       
   321   <!--
       
   322   // Private objects are initially displayed (because if
       
   323   // javascript is turned off then we want them to be
       
   324   // visible); but by default, we want to hide them.  So hide
       
   325   // them unless we have a cookie that says to show them.
       
   326   checkCookie()
       
   327   // -->
       
   328 </script>
       
   329   
       
   330 </body>
       
   331 </html>