|
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.AntWriter</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="buildtools-module.html">Module buildtools</a> :: |
|
38 Class AntWriter |
|
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="buildtools.AntWriter-class.html" |
|
49 target="_top">no frames</a>]</span></td></tr> |
|
50 </table> |
|
51 </td> |
|
52 </tr> |
|
53 </table> |
|
54 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
55 <h1 class="epydoc">Class AntWriter</h1><span class="codelink"><a href="buildtools-pysrc.html#AntWriter">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 <a href="buildtools.AbstractOutputWriter-class.html">AbstractOutputWriter</a> --+ |
|
58 | |
|
59 <strong class="uidshort">AntWriter</strong> |
|
60 </pre> |
|
61 |
|
62 <hr /> |
|
63 Implements Ant XML output format.<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"> </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.AntWriter-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#AntWriter.__init__">source 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"> </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.AntWriter-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#AntWriter.writeTopLevel">source 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"> </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.AntWriter-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 Writes the command list to Ant format.</td> |
|
129 <td align="right" valign="top"> |
|
130 <span class="codelink"><a href="buildtools-pysrc.html#AntWriter.write">source 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"> </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="__stageToTarget"></a><span class="summary-sig-name">__stageToTarget</span>(<span class="summary-sig-arg">self</span>, |
|
145 <span class="summary-sig-arg">doc</span>, |
|
146 <span class="summary-sig-arg">stage</span>, |
|
147 <span class="summary-sig-arg">cmds</span>)</span><br /> |
|
148 Convert a stage into an Ant target.</td> |
|
149 <td align="right" valign="top"> |
|
150 <span class="codelink"><a href="buildtools-pysrc.html#AntWriter.__stageToTarget">source code</a></span> |
|
151 |
|
152 </td> |
|
153 </tr> |
|
154 </table> |
|
155 |
|
156 </td> |
|
157 </tr> |
|
158 <tr> |
|
159 <td colspan="2" class="summary"> |
|
160 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="buildtools.AbstractOutputWriter-class.html">AbstractOutputWriter</a></code></b>: |
|
161 <code><a href="buildtools.AbstractOutputWriter-class.html#__call__">__call__</a></code>, |
|
162 <code><a href="buildtools.AbstractOutputWriter-class.html#close">close</a></code> |
|
163 </p> |
|
164 </td> |
|
165 </tr> |
|
166 </table> |
|
167 <!-- ==================== STATIC METHODS ==================== --> |
|
168 <a name="section-StaticMethods"></a> |
|
169 <table class="summary" border="1" cellpadding="3" |
|
170 cellspacing="0" width="100%" bgcolor="white"> |
|
171 <tr bgcolor="#70b0f0" class="table-header"> |
|
172 <td colspan="2" class="table-header"> |
|
173 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
174 <tr valign="top"> |
|
175 <td align="left"><span class="table-header">Static Methods</span></td> |
|
176 <td align="right" valign="top" |
|
177 ><span class="options">[<a href="#section-StaticMethods" |
|
178 class="privatelink" onclick="toggle_private();" |
|
179 >hide private</a>]</span></td> |
|
180 </tr> |
|
181 </table> |
|
182 </td> |
|
183 </tr> |
|
184 <tr class="private"> |
|
185 <td width="15%" align="right" valign="top" class="summary"> |
|
186 <span class="summary-type"> </span> |
|
187 </td><td class="summary"> |
|
188 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
189 <tr> |
|
190 <td><span class="summary-sig"><a name="__commandToAnt"></a><span class="summary-sig-name">__commandToAnt</span>(<span class="summary-sig-arg">doc</span>, |
|
191 <span class="summary-sig-arg">cmd</span>)</span><br /> |
|
192 Convert a command into an Ant task.</td> |
|
193 <td align="right" valign="top"> |
|
194 <span class="codelink"><a href="buildtools-pysrc.html#AntWriter.__commandToAnt">source code</a></span> |
|
195 |
|
196 </td> |
|
197 </tr> |
|
198 </table> |
|
199 |
|
200 </td> |
|
201 </tr> |
|
202 <tr class="private"> |
|
203 <td width="15%" align="right" valign="top" class="summary"> |
|
204 <span class="summary-type"> </span> |
|
205 </td><td class="summary"> |
|
206 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
207 <tr> |
|
208 <td><span class="summary-sig"><a name="__getCommandByStage"></a><span class="summary-sig-name">__getCommandByStage</span>(<span class="summary-sig-arg">cmdList</span>)</span><br /> |
|
209 Reorder a CommandList into a list of stages.</td> |
|
210 <td align="right" valign="top"> |
|
211 <span class="codelink"><a href="buildtools-pysrc.html#AntWriter.__getCommandByStage">source code</a></span> |
|
212 |
|
213 </td> |
|
214 </tr> |
|
215 </table> |
|
216 |
|
217 </td> |
|
218 </tr> |
|
219 </table> |
|
220 <!-- ==================== METHOD DETAILS ==================== --> |
|
221 <a name="section-MethodDetails"></a> |
|
222 <table class="details" border="1" cellpadding="3" |
|
223 cellspacing="0" width="100%" bgcolor="white"> |
|
224 <tr bgcolor="#70b0f0" class="table-header"> |
|
225 <td colspan="2" class="table-header"> |
|
226 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
227 <tr valign="top"> |
|
228 <td align="left"><span class="table-header">Method Details</span></td> |
|
229 <td align="right" valign="top" |
|
230 ><span class="options">[<a href="#section-MethodDetails" |
|
231 class="privatelink" onclick="toggle_private();" |
|
232 >hide private</a>]</span></td> |
|
233 </tr> |
|
234 </table> |
|
235 </td> |
|
236 </tr> |
|
237 </table> |
|
238 <a name="__init__"></a> |
|
239 <div> |
|
240 <table class="details" border="1" cellpadding="3" |
|
241 cellspacing="0" width="100%" bgcolor="white"> |
|
242 <tr><td> |
|
243 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
244 <tr valign="top"><td> |
|
245 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
246 <span class="sig-arg">fileOut</span>)</span> |
|
247 <br /><em class="fname">(Constructor)</em> |
|
248 </h3> |
|
249 </td><td align="right" valign="top" |
|
250 ><span class="codelink"><a href="buildtools-pysrc.html#AntWriter.__init__">source code</a></span> |
|
251 </td> |
|
252 </table> |
|
253 |
|
254 |
|
255 <dl class="fields"> |
|
256 <dt>Overrides: |
|
257 <a href="buildtools.AbstractOutputWriter-class.html#__init__">AbstractOutputWriter.__init__</a> |
|
258 </dt> |
|
259 </dl> |
|
260 </td></tr></table> |
|
261 </div> |
|
262 <a name="writeTopLevel"></a> |
|
263 <div> |
|
264 <table class="details" border="1" cellpadding="3" |
|
265 cellspacing="0" width="100%" bgcolor="white"> |
|
266 <tr><td> |
|
267 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
268 <tr valign="top"><td> |
|
269 <h3 class="epydoc"><span class="sig"><span class="sig-name">writeTopLevel</span>(<span class="sig-arg">self</span>, |
|
270 <span class="sig-arg">config_list</span>, |
|
271 <span class="sig-arg">spec_name</span>, |
|
272 <span class="sig-arg">output_path</span>, |
|
273 <span class="sig-arg">xml_file</span>)</span> |
|
274 </h3> |
|
275 </td><td align="right" valign="top" |
|
276 ><span class="codelink"><a href="buildtools-pysrc.html#AntWriter.writeTopLevel">source code</a></span> |
|
277 </td> |
|
278 </table> |
|
279 |
|
280 Method to override to implement top level commands. |
|
281 <dl class="fields"> |
|
282 <dt>Overrides: |
|
283 <a href="buildtools.AbstractOutputWriter-class.html#writeTopLevel">AbstractOutputWriter.writeTopLevel</a> |
|
284 <dd><em class="note">(inherited documentation)</em></dd> |
|
285 </dt> |
|
286 </dl> |
|
287 </td></tr></table> |
|
288 </div> |
|
289 <a name="write"></a> |
|
290 <div> |
|
291 <table class="details" border="1" cellpadding="3" |
|
292 cellspacing="0" width="100%" bgcolor="white"> |
|
293 <tr><td> |
|
294 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
295 <tr valign="top"><td> |
|
296 <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>, |
|
297 <span class="sig-arg">cmdList</span>)</span> |
|
298 </h3> |
|
299 </td><td align="right" valign="top" |
|
300 ><span class="codelink"><a href="buildtools-pysrc.html#AntWriter.write">source code</a></span> |
|
301 </td> |
|
302 </table> |
|
303 |
|
304 Writes the command list to Ant format. |
|
305 <dl class="fields"> |
|
306 <dt>Overrides: |
|
307 <a href="buildtools.AbstractOutputWriter-class.html#write">AbstractOutputWriter.write</a> |
|
308 </dt> |
|
309 </dl> |
|
310 </td></tr></table> |
|
311 </div> |
|
312 <br /> |
|
313 <!-- ==================== NAVIGATION BAR ==================== --> |
|
314 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
315 bgcolor="#a0c0ff" cellspacing="0"> |
|
316 <tr valign="middle"> |
|
317 |
|
318 <!-- Tree link --> |
|
319 <th> <a |
|
320 href="module-tree.html">Trees</a> </th> |
|
321 |
|
322 <!-- Index link --> |
|
323 <th> <a |
|
324 href="identifier-index.html">Indices</a> </th> |
|
325 |
|
326 <!-- Help link --> |
|
327 <th> <a |
|
328 href="help.html">Help</a> </th> |
|
329 |
|
330 <th class="navbar" width="100%"></th> |
|
331 </tr> |
|
332 </table> |
|
333 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
334 <tr> |
|
335 <td align="left" class="footer"> |
|
336 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 |
|
337 </td> |
|
338 <td align="right" class="footer"> |
|
339 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
340 </td> |
|
341 </tr> |
|
342 </table> |
|
343 |
|
344 <script type="text/javascript"> |
|
345 <!-- |
|
346 // Private objects are initially displayed (because if |
|
347 // javascript is turned off then we want them to be |
|
348 // visible); but by default, we want to hide them. So hide |
|
349 // them unless we have a cookie that says to show them. |
|
350 checkCookie() |
|
351 // --> |
|
352 </script> |
|
353 |
|
354 </body> |
|
355 </html> |