doc/api/python/rom-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>rom</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;rom
       
    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="rom-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 rom</h1><span class="codelink"><a href="rom-pysrc.html">source&nbsp;code</a></span><br /><br />
       
    55 This modules implements rombuilders.<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="rom.IMakerRomBuilder-class.html" class="summary-name">IMakerRomBuilder</a><br />
       
    79       Configuration Builder for iMaker tool.
       
    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="rom.RomBuilder-class.html" class="summary-name">RomBuilder</a><br />
       
    87       Builder that create roms using makefpsx.
       
    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="rom.Image-class.html" class="summary-name">Image</a><br />
       
    95       An Image object represents a ROM image, or .fpsx file.
       
    96     </td>
       
    97   </tr>
       
    98 </table>
       
    99 <!-- ==================== FUNCTIONS ==================== -->
       
   100 <a name="section-Functions"></a>
       
   101 <table class="summary" border="1" cellpadding="3"
       
   102        cellspacing="0" width="100%" bgcolor="white">
       
   103 <tr bgcolor="#70b0f0" class="table-header">
       
   104   <td colspan="2" class="table-header">
       
   105     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   106       <tr valign="top">
       
   107         <td align="left"><span class="table-header">Functions</span></td>
       
   108         <td align="right" valign="top"
       
   109          ><span class="options">[<a href="#section-Functions"
       
   110          class="privatelink" onclick="toggle_private();"
       
   111          >hide private</a>]</span></td>
       
   112       </tr>
       
   113     </table>
       
   114   </td>
       
   115 </tr>
       
   116 <tr>
       
   117     <td width="15%" align="right" valign="top" class="summary">
       
   118       <span class="summary-type">&nbsp;</span>
       
   119     </td><td class="summary">
       
   120       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   121         <tr>
       
   122           <td><span class="summary-sig"><a name="get_abstract_parents"></a><span class="summary-sig-name">get_abstract_parents</span>(<span class="summary-sig-arg">config</span>)</span><br />
       
   123       Create from a config element a list of parent
       
   124 that are abstract (not buildable).</td>
       
   125           <td align="right" valign="top">
       
   126             <span class="codelink"><a href="rom-pysrc.html#get_abstract_parents">source&nbsp;code</a></span>
       
   127             
       
   128           </td>
       
   129         </tr>
       
   130       </table>
       
   131       
       
   132     </td>
       
   133   </tr>
       
   134 <tr>
       
   135     <td width="15%" align="right" valign="top" class="summary">
       
   136       <span class="summary-type">&nbsp;</span>
       
   137     </td><td class="summary">
       
   138       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   139         <tr>
       
   140           <td><span class="summary-sig"><a name="read_file_content"></a><span class="summary-sig-name">read_file_content</span>(<span class="summary-sig-arg">filename</span>)</span><br />
       
   141       Read the whole file content.</td>
       
   142           <td align="right" valign="top">
       
   143             <span class="codelink"><a href="rom-pysrc.html#read_file_content">source&nbsp;code</a></span>
       
   144             
       
   145           </td>
       
   146         </tr>
       
   147       </table>
       
   148       
       
   149     </td>
       
   150   </tr>
       
   151 <tr>
       
   152     <td width="15%" align="right" valign="top" class="summary">
       
   153       <span class="summary-type">&nbsp;</span>
       
   154     </td><td class="summary">
       
   155       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   156         <tr>
       
   157           <td><span class="summary-sig"><a name="escape_string"></a><span class="summary-sig-name">escape_string</span>(<span class="summary-sig-arg">string</span>,
       
   158         <span class="summary-sig-arg">config</span>)</span><br />
       
   159       Escape a string recursively.</td>
       
   160           <td align="right" valign="top">
       
   161             <span class="codelink"><a href="rom-pysrc.html#escape_string">source&nbsp;code</a></span>
       
   162             
       
   163           </td>
       
   164         </tr>
       
   165       </table>
       
   166       
       
   167     </td>
       
   168   </tr>
       
   169 <tr>
       
   170     <td width="15%" align="right" valign="top" class="summary">
       
   171       <span class="summary-type">&nbsp;</span>
       
   172     </td><td class="summary">
       
   173       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   174         <tr>
       
   175           <td><span class="summary-sig"><a name="get_makefile_target"></a><span class="summary-sig-name">get_makefile_target</span>(<span class="summary-sig-arg">text</span>)</span><br />
       
   176       Retrieve the target name of a step</td>
       
   177           <td align="right" valign="top">
       
   178             <span class="codelink"><a href="rom-pysrc.html#get_makefile_target">source&nbsp;code</a></span>
       
   179             
       
   180           </td>
       
   181         </tr>
       
   182       </table>
       
   183       
       
   184     </td>
       
   185   </tr>
       
   186 <tr>
       
   187     <td width="15%" align="right" valign="top" class="summary">
       
   188       <span class="summary-type">&nbsp;</span>
       
   189     </td><td class="summary">
       
   190       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   191         <tr>
       
   192           <td><span class="summary-sig"><a name="remove_duplicates"></a><span class="summary-sig-name">remove_duplicates</span>(<span class="summary-sig-arg">array</span>)</span><br />
       
   193       Remove dusplicates values from an array.</td>
       
   194           <td align="right" valign="top">
       
   195             <span class="codelink"><a href="rom-pysrc.html#remove_duplicates">source&nbsp;code</a></span>
       
   196             
       
   197           </td>
       
   198         </tr>
       
   199       </table>
       
   200       
       
   201     </td>
       
   202   </tr>
       
   203 <tr>
       
   204     <td width="15%" align="right" valign="top" class="summary">
       
   205       <span class="summary-type">&nbsp;</span>
       
   206     </td><td class="summary">
       
   207       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   208         <tr>
       
   209           <td><span class="summary-sig"><a name="get_product_path_bsf"></a><span class="summary-sig-name">get_product_path_bsf</span>(<span class="summary-sig-arg">product</span>)</span><br />
       
   210       Get product path using the BSF.</td>
       
   211           <td align="right" valign="top">
       
   212             <span class="codelink"><a href="rom-pysrc.html#get_product_path_bsf">source&nbsp;code</a></span>
       
   213             
       
   214           </td>
       
   215         </tr>
       
   216       </table>
       
   217       
       
   218     </td>
       
   219   </tr>
       
   220 <tr>
       
   221     <td width="15%" align="right" valign="top" class="summary">
       
   222       <span class="summary-type">&nbsp;</span>
       
   223     </td><td class="summary">
       
   224       <table width="100%" cellpadding="0" cellspacing="0" border="0">
       
   225         <tr>
       
   226           <td><span class="summary-sig"><a name="get_product_path_var"></a><span class="summary-sig-name">get_product_path_var</span>(<span class="summary-sig-arg">product</span>)</span><br />
       
   227       Get product path using the new tool.</td>
       
   228           <td align="right" valign="top">
       
   229             <span class="codelink"><a href="rom-pysrc.html#get_product_path_var">source&nbsp;code</a></span>
       
   230             
       
   231           </td>
       
   232         </tr>
       
   233       </table>
       
   234       
       
   235     </td>
       
   236   </tr>
       
   237 </table>
       
   238 <!-- ==================== VARIABLES ==================== -->
       
   239 <a name="section-Variables"></a>
       
   240 <table class="summary" border="1" cellpadding="3"
       
   241        cellspacing="0" width="100%" bgcolor="white">
       
   242 <tr bgcolor="#70b0f0" class="table-header">
       
   243   <td colspan="2" class="table-header">
       
   244     <table border="0" cellpadding="0" cellspacing="0" width="100%">
       
   245       <tr valign="top">
       
   246         <td align="left"><span class="table-header">Variables</span></td>
       
   247         <td align="right" valign="top"
       
   248          ><span class="options">[<a href="#section-Variables"
       
   249          class="privatelink" onclick="toggle_private();"
       
   250          >hide private</a>]</span></td>
       
   251       </tr>
       
   252     </table>
       
   253   </td>
       
   254 </tr>
       
   255 <tr>
       
   256     <td width="15%" align="right" valign="top" class="summary">
       
   257       <span class="summary-type">&nbsp;</span>
       
   258     </td><td class="summary">
       
   259         <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(&quot;rom&quot;)">logging.getLogger(&quot;rom&quot;)</code>
       
   260     </td>
       
   261   </tr>
       
   262 </table>
       
   263 <!-- ==================== NAVIGATION BAR ==================== -->
       
   264 <table class="navbar" border="0" width="100%" cellpadding="0"
       
   265        bgcolor="#a0c0ff" cellspacing="0">
       
   266   <tr valign="middle">
       
   267 
       
   268   <!-- Tree link -->
       
   269       <th>&nbsp;&nbsp;&nbsp;<a
       
   270         href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
       
   271 
       
   272   <!-- Index link -->
       
   273       <th>&nbsp;&nbsp;&nbsp;<a
       
   274         href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
       
   275 
       
   276   <!-- Help link -->
       
   277       <th>&nbsp;&nbsp;&nbsp;<a
       
   278         href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
       
   279 
       
   280       <th class="navbar" width="100%"></th>
       
   281   </tr>
       
   282 </table>
       
   283 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
       
   284   <tr>
       
   285     <td align="left" class="footer">
       
   286     Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
       
   287     </td>
       
   288     <td align="right" class="footer">
       
   289       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
       
   290     </td>
       
   291   </tr>
       
   292 </table>
       
   293 
       
   294 <script type="text/javascript">
       
   295   <!--
       
   296   // Private objects are initially displayed (because if
       
   297   // javascript is turned off then we want them to be
       
   298   // visible); but by default, we want to hide them.  So hide
       
   299   // them unless we have a cookie that says to show them.
       
   300   checkCookie()
       
   301   // -->
       
   302 </script>
       
   303   
       
   304 </body>
       
   305 </html>