doc/api/python/buildtools.MakeWriter-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>buildtools.MakeWriter</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="buildtools-module.html">Module&nbsp;buildtools</a> ::
       
    38         Class&nbsp;MakeWriter
       
    39       </span>
       
    40     </td>
       
    41     <td>
       
    42       <table cellpadding="0" cellspacing="0">
       
    43         <!-- hide/show private -->
       
    44         <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
       
    45     onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
       
    46         <tr><td align="right"><span class="options"
       
    47             >[<a href="frames.html" target="_top">frames</a
       
    48             >]&nbsp;|&nbsp;<a href="buildtools.MakeWriter-class.html"
       
    49             target="_top">no&nbsp;frames</a>]</span></td></tr>
       
    50       </table>
       
    51     </td>
       
    52   </tr>
       
    53 </table>
       
    54 <!-- ==================== CLASS DESCRIPTION ==================== -->
       
    55 <h1 class="epydoc">Class MakeWriter</h1><span class="codelink"><a href="buildtools-pysrc.html#MakeWriter">source&nbsp;code</a></span><br /><br />
       
    56 <pre class="base-tree">
       
    57 <a href="buildtools.AbstractOutputWriter-class.html">AbstractOutputWriter</a> --+
       
    58                        |
       
    59                       <strong class="uidshort">MakeWriter</strong>
       
    60 </pre>
       
    61 
       
    62 <hr />
       
    63 Implements Makefile writer.<br /><br />
       
    64 
       
    65 <!-- ==================== INSTANCE METHODS ==================== -->
       
    66 <a name="section-InstanceMethods"></a>
       
    67 <table class="summary" border="1" cellpadding="3"
       
    68        cellspacing="0" width="100%" bgcolor="white">
       
    69 <tr bgcolor="#70b0f0" class="table-header">
       
    70   <td colspan="2" class="table-header">
       
    71     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
    72       <tr valign="top">
       
    73         <td align="left"><span class="table-header">Instance Methods</span></td>
       
    74         <td align="right" valign="top"
       
    75          ><span class="options">[<a href="#section-InstanceMethods"
       
    76          class="privatelink" onclick="toggle_private();"
       
    77          >hide private</a>]</span></td>
       
    78       </tr>
       
    79     </table>
       
    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       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
    87         <tr>
       
    88           <td><span class="summary-sig"><a href="buildtools.MakeWriter-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
       
    89         <span class="summary-sig-arg">fileOut</span>)</span></td>
       
    90           <td align="right" valign="top">
       
    91             <span class="codelink"><a href="buildtools-pysrc.html#MakeWriter.__init__">source&nbsp;code</a></span>
       
    92             
       
    93           </td>
       
    94         </tr>
       
    95       </table>
       
    96       
       
    97     </td>
       
    98   </tr>
       
    99 <tr>
       
   100     <td width="15%" align="right" valign="top" class="summary">
       
   101       <span class="summary-type">&nbsp;</span>
       
   102     </td><td class="summary">
       
   103       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   104         <tr>
       
   105           <td><span class="summary-sig"><a href="buildtools.MakeWriter-class.html#writeTopLevel" class="summary-sig-name">writeTopLevel</a>(<span class="summary-sig-arg">self</span>,
       
   106         <span class="summary-sig-arg">config_list</span>,
       
   107         <span class="summary-sig-arg">spec_name</span>,
       
   108         <span class="summary-sig-arg">output_path</span>,
       
   109         <span class="summary-sig-arg">xml_file</span>)</span><br />
       
   110       Method to override to implement top level commands.</td>
       
   111           <td align="right" valign="top">
       
   112             <span class="codelink"><a href="buildtools-pysrc.html#MakeWriter.writeTopLevel">source&nbsp;code</a></span>
       
   113             
       
   114           </td>
       
   115         </tr>
       
   116       </table>
       
   117       
       
   118     </td>
       
   119   </tr>
       
   120 <tr>
       
   121     <td width="15%" align="right" valign="top" class="summary">
       
   122       <span class="summary-type">&nbsp;</span>
       
   123     </td><td class="summary">
       
   124       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   125         <tr>
       
   126           <td><span class="summary-sig"><a href="buildtools.MakeWriter-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>,
       
   127         <span class="summary-sig-arg">cmdList</span>)</span><br />
       
   128       Converts the list of command into Makefile.</td>
       
   129           <td align="right" valign="top">
       
   130             <span class="codelink"><a href="buildtools-pysrc.html#MakeWriter.write">source&nbsp;code</a></span>
       
   131             
       
   132           </td>
       
   133         </tr>
       
   134       </table>
       
   135       
       
   136     </td>
       
   137   </tr>
       
   138 <tr class="private">
       
   139     <td width="15%" align="right" valign="top" class="summary">
       
   140       <span class="summary-type">&nbsp;</span>
       
   141     </td><td class="summary">
       
   142       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   143         <tr>
       
   144           <td><span class="summary-sig"><a name="__commandToTarget"></a><span class="summary-sig-name">__commandToTarget</span>(<span class="summary-sig-arg">self</span>,
       
   145         <span class="summary-sig-arg">cmd</span>)</span><br />
       
   146       Converting a Command into a Makefile target.</td>
       
   147           <td align="right" valign="top">
       
   148             <span class="codelink"><a href="buildtools-pysrc.html#MakeWriter.__commandToTarget">source&nbsp;code</a></span>
       
   149             
       
   150           </td>
       
   151         </tr>
       
   152       </table>
       
   153       
       
   154     </td>
       
   155   </tr>
       
   156   <tr>
       
   157     <td colspan="2" class="summary">
       
   158     <p class="indent-wrapped-lines"><b>Inherited from <code><a href="buildtools.AbstractOutputWriter-class.html">AbstractOutputWriter</a></code></b>:
       
   159       <code><a href="buildtools.AbstractOutputWriter-class.html#__call__">__call__</a></code>,
       
   160       <code><a href="buildtools.AbstractOutputWriter-class.html#close">close</a></code>
       
   161       </p>
       
   162     </td>
       
   163   </tr>
       
   164 </table>
       
   165 <!-- ==================== METHOD DETAILS ==================== -->
       
   166 <a name="section-MethodDetails"></a>
       
   167 <table class="details" border="1" cellpadding="3"
       
   168        cellspacing="0" width="100%" bgcolor="white">
       
   169 <tr bgcolor="#70b0f0" class="table-header">
       
   170   <td colspan="2" class="table-header">
       
   171     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   172       <tr valign="top">
       
   173         <td align="left"><span class="table-header">Method Details</span></td>
       
   174         <td align="right" valign="top"
       
   175          ><span class="options">[<a href="#section-MethodDetails"
       
   176          class="privatelink" onclick="toggle_private();"
       
   177          >hide private</a>]</span></td>
       
   178       </tr>
       
   179     </table>
       
   180   </td>
       
   181 </tr>
       
   182 </table>
       
   183 <a name="__init__"></a>
       
   184 <div>
       
   185 <table class="details" border="1" cellpadding="3"
       
   186        cellspacing="0" width="100%" bgcolor="white">
       
   187 <tr><td>
       
   188   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   189   <tr valign="top"><td>
       
   190   <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
       
   191         <span class="sig-arg">fileOut</span>)</span>
       
   192     <br /><em class="fname">(Constructor)</em>
       
   193   </h3>
       
   194   </td><td align="right" valign="top"
       
   195     ><span class="codelink"><a href="buildtools-pysrc.html#MakeWriter.__init__">source&nbsp;code</a></span>&nbsp;
       
   196     </td>
       
   197   </table>
       
   198   
       
   199   
       
   200   <dl class="fields">
       
   201     <dt>Overrides:
       
   202       <a href="buildtools.AbstractOutputWriter-class.html#__init__">AbstractOutputWriter.__init__</a>
       
   203     </dt>
       
   204   </dl>
       
   205 </td></tr></table>
       
   206 </div>
       
   207 <a name="writeTopLevel"></a>
       
   208 <div>
       
   209 <table class="details" border="1" cellpadding="3"
       
   210        cellspacing="0" width="100%" bgcolor="white">
       
   211 <tr><td>
       
   212   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   213   <tr valign="top"><td>
       
   214   <h3 class="epydoc"><span class="sig"><span class="sig-name">writeTopLevel</span>(<span class="sig-arg">self</span>,
       
   215         <span class="sig-arg">config_list</span>,
       
   216         <span class="sig-arg">spec_name</span>,
       
   217         <span class="sig-arg">output_path</span>,
       
   218         <span class="sig-arg">xml_file</span>)</span>
       
   219   </h3>
       
   220   </td><td align="right" valign="top"
       
   221     ><span class="codelink"><a href="buildtools-pysrc.html#MakeWriter.writeTopLevel">source&nbsp;code</a></span>&nbsp;
       
   222     </td>
       
   223   </table>
       
   224   
       
   225   Method to override to implement top level commands.
       
   226   <dl class="fields">
       
   227     <dt>Overrides:
       
   228       <a href="buildtools.AbstractOutputWriter-class.html#writeTopLevel">AbstractOutputWriter.writeTopLevel</a>
       
   229         <dd><em class="note">(inherited documentation)</em></dd>
       
   230     </dt>
       
   231   </dl>
       
   232 </td></tr></table>
       
   233 </div>
       
   234 <a name="write"></a>
       
   235 <div>
       
   236 <table class="details" border="1" cellpadding="3"
       
   237        cellspacing="0" width="100%" bgcolor="white">
       
   238 <tr><td>
       
   239   <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   240   <tr valign="top"><td>
       
   241   <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,
       
   242         <span class="sig-arg">cmdList</span>)</span>
       
   243   </h3>
       
   244   </td><td align="right" valign="top"
       
   245     ><span class="codelink"><a href="buildtools-pysrc.html#MakeWriter.write">source&nbsp;code</a></span>&nbsp;
       
   246     </td>
       
   247   </table>
       
   248   
       
   249   Converts the list of command into Makefile.
       
   250   <dl class="fields">
       
   251     <dt>Overrides:
       
   252       <a href="buildtools.AbstractOutputWriter-class.html#write">AbstractOutputWriter.write</a>
       
   253     </dt>
       
   254   </dl>
       
   255 </td></tr></table>
       
   256 </div>
       
   257 <br />
       
   258 <!-- ==================== NAVIGATION BAR ==================== -->
       
   259 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   260        bgcolor="#a0c0ff" cellspacing="0">
       
   261   <tr valign="middle">
       
   262 
       
   263   <!-- Tree link -->
       
   264       <th>&nbsp;&nbsp;&nbsp;<a
       
   265         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   266 
       
   267   <!-- Index link -->
       
   268       <th>&nbsp;&nbsp;&nbsp;<a
       
   269         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   270 
       
   271   <!-- Help link -->
       
   272       <th>&nbsp;&nbsp;&nbsp;<a
       
   273         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   274 
       
   275       <th class="navbar" width="100%"></th>
       
   276   </tr>
       
   277 </table>
       
   278 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   279   <tr>
       
   280     <td align="left" class="footer">
       
   281     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009
       
   282     </td>
       
   283     <td align="right" class="footer">
       
   284       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   285     </td>
       
   286   </tr>
       
   287 </table>
       
   288 
       
   289 <script type="text/javascript">
       
   290   <!--
       
   291   // Private objects are initially displayed (because if
       
   292   // javascript is turned off then we want them to be
       
   293   // visible); but by default, we want to hide them.  So hide
       
   294   // them unless we have a cookie that says to show them.
       
   295   checkCookie()
       
   296   // -->
       
   297 </script>
       
   298   
       
   299 </body>
       
   300 </html>