|
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>imaker.api</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> <a |
|
20 href="module-tree.html">Trees</a> </th> |
|
21 |
|
22 <!-- Index link --> |
|
23 <th> <a |
|
24 href="identifier-index.html">Indices</a> </th> |
|
25 |
|
26 <!-- Help link --> |
|
27 <th> <a |
|
28 href="help.html">Help</a> </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="imaker-module.html">Package imaker</a> :: |
|
38 Module api |
|
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 private</a>]</span></td></tr> |
|
46 <tr><td align="right"><span class="options" |
|
47 >[<a href="frames.html" target="_top">frames</a |
|
48 >] | <a href="imaker.api-module.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== MODULE DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Module api</h1><span class="codelink"><a href="imaker.api-pysrc.html">source code</a></span><br /><br /> |
|
56 This module is an helper to interface iMaker.<br /><br /> |
|
57 |
|
58 <!-- ==================== CLASSES ==================== --> |
|
59 <a name="section-Classes"></a> |
|
60 <table class="summary" border="1" cellpadding="3" |
|
61 cellspacing="0" width="100%" bgcolor="white"> |
|
62 <tr bgcolor="#70b0f0" class="table-header"> |
|
63 <td colspan="2" class="table-header"> |
|
64 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
65 <tr valign="top"> |
|
66 <td align="left"><span class="table-header">Classes</span></td> |
|
67 <td align="right" valign="top" |
|
68 ><span class="options">[<a href="#section-Classes" |
|
69 class="privatelink" onclick="toggle_private();" |
|
70 >hide private</a>]</span></td> |
|
71 </tr> |
|
72 </table> |
|
73 </td> |
|
74 </tr> |
|
75 <tr> |
|
76 <td width="15%" align="right" valign="top" class="summary"> |
|
77 <span class="summary-type"> </span> |
|
78 </td><td class="summary"> |
|
79 <a href="imaker.api.IMakerConfigScanner-class.html" class="summary-name">IMakerConfigScanner</a><br /> |
|
80 Specialize the abstract filescanner to support detection of the configuration. |
|
81 </td> |
|
82 </tr> |
|
83 </table> |
|
84 <!-- ==================== FUNCTIONS ==================== --> |
|
85 <a name="section-Functions"></a> |
|
86 <table class="summary" border="1" cellpadding="3" |
|
87 cellspacing="0" width="100%" bgcolor="white"> |
|
88 <tr bgcolor="#70b0f0" class="table-header"> |
|
89 <td colspan="2" class="table-header"> |
|
90 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
91 <tr valign="top"> |
|
92 <td align="left"><span class="table-header">Functions</span></td> |
|
93 <td align="right" valign="top" |
|
94 ><span class="options">[<a href="#section-Functions" |
|
95 class="privatelink" onclick="toggle_private();" |
|
96 >hide private</a>]</span></td> |
|
97 </tr> |
|
98 </table> |
|
99 </td> |
|
100 </tr> |
|
101 <tr> |
|
102 <td width="15%" align="right" valign="top" class="summary"> |
|
103 <span class="summary-type"> </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 name="scan_configs"></a><span class="summary-sig-name">scan_configs</span>(<span class="summary-sig-arg">includes</span>, |
|
108 <span class="summary-sig-arg">excludes</span>)</span><br /> |
|
109 Use iMaker to scan the available buildable configurations.</td> |
|
110 <td align="right" valign="top"> |
|
111 <span class="codelink"><a href="imaker.api-pysrc.html#scan_configs">source code</a></span> |
|
112 |
|
113 </td> |
|
114 </tr> |
|
115 </table> |
|
116 |
|
117 </td> |
|
118 </tr> |
|
119 <tr> |
|
120 <td width="15%" align="right" valign="top" class="summary"> |
|
121 <span class="summary-type"> </span> |
|
122 </td><td class="summary"> |
|
123 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
124 <tr> |
|
125 <td><span class="summary-sig"><a name="targets_for_config"></a><span class="summary-sig-name">targets_for_config</span>(<span class="summary-sig-arg">config</span>)</span><br /> |
|
126 Return the list of target supported by the provided configuration of iMaker.</td> |
|
127 <td align="right" valign="top"> |
|
128 <span class="codelink"><a href="imaker.api-pysrc.html#targets_for_config">source code</a></span> |
|
129 |
|
130 </td> |
|
131 </tr> |
|
132 </table> |
|
133 |
|
134 </td> |
|
135 </tr> |
|
136 <tr> |
|
137 <td width="15%" align="right" valign="top" class="summary"> |
|
138 <span class="summary-type"> </span> |
|
139 </td><td class="summary"> |
|
140 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
141 <tr> |
|
142 <td><span class="summary-sig"><a name="get_product_dir"></a><span class="summary-sig-name">get_product_dir</span>(<span class="summary-sig-arg">product</span>)</span><br /> |
|
143 Return the PRODUCT_DIR variable from iMaker.</td> |
|
144 <td align="right" valign="top"> |
|
145 <span class="codelink"><a href="imaker.api-pysrc.html#get_product_dir">source code</a></span> |
|
146 |
|
147 </td> |
|
148 </tr> |
|
149 </table> |
|
150 |
|
151 </td> |
|
152 </tr> |
|
153 <tr> |
|
154 <td width="15%" align="right" valign="top" class="summary"> |
|
155 <span class="summary-type"> </span> |
|
156 </td><td class="summary"> |
|
157 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
158 <tr> |
|
159 <td><span class="summary-sig"><a name="get_variable"></a><span class="summary-sig-name">get_variable</span>(<span class="summary-sig-arg">variable</span>, |
|
160 <span class="summary-sig-arg">target</span>=<span class="summary-sig-default">None</span>, |
|
161 <span class="summary-sig-arg">product</span>=<span class="summary-sig-default">None</span>, |
|
162 <span class="summary-sig-arg">config</span>=<span class="summary-sig-default">None</span>, |
|
163 <span class="summary-sig-arg">default</span>=<span class="summary-sig-default">None</span>)</span><br /> |
|
164 Get variable value from iMaker.</td> |
|
165 <td align="right" valign="top"> |
|
166 <span class="codelink"><a href="imaker.api-pysrc.html#get_variable">source code</a></span> |
|
167 |
|
168 </td> |
|
169 </tr> |
|
170 </table> |
|
171 |
|
172 </td> |
|
173 </tr> |
|
174 </table> |
|
175 <!-- ==================== NAVIGATION BAR ==================== --> |
|
176 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
177 bgcolor="#a0c0ff" cellspacing="0"> |
|
178 <tr valign="middle"> |
|
179 |
|
180 <!-- Tree link --> |
|
181 <th> <a |
|
182 href="module-tree.html">Trees</a> </th> |
|
183 |
|
184 <!-- Index link --> |
|
185 <th> <a |
|
186 href="identifier-index.html">Indices</a> </th> |
|
187 |
|
188 <!-- Help link --> |
|
189 <th> <a |
|
190 href="help.html">Help</a> </th> |
|
191 |
|
192 <th class="navbar" width="100%"></th> |
|
193 </tr> |
|
194 </table> |
|
195 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
196 <tr> |
|
197 <td align="left" class="footer"> |
|
198 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
199 </td> |
|
200 <td align="right" class="footer"> |
|
201 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
202 </td> |
|
203 </tr> |
|
204 </table> |
|
205 |
|
206 <script type="text/javascript"> |
|
207 <!-- |
|
208 // Private objects are initially displayed (because if |
|
209 // javascript is turned off then we want them to be |
|
210 // visible); but by default, we want to hide them. So hide |
|
211 // them unless we have a cookie that says to show them. |
|
212 checkCookie() |
|
213 // --> |
|
214 </script> |
|
215 |
|
216 </body> |
|
217 </html> |