|
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>archive.builders.ArchivePreBuilder</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="archive-module.html">Package archive</a> :: |
|
38 <a href="archive.builders-module.html">Module builders</a> :: |
|
39 Class ArchivePreBuilder |
|
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 private</a>]</span></td></tr> |
|
47 <tr><td align="right"><span class="options" |
|
48 >[<a href="frames.html" target="_top">frames</a |
|
49 >] | <a href="archive.builders.ArchivePreBuilder-class.html" |
|
50 target="_top">no frames</a>]</span></td></tr> |
|
51 </table> |
|
52 </td> |
|
53 </tr> |
|
54 </table> |
|
55 <!-- ==================== CLASS DESCRIPTION ==================== --> |
|
56 <h1 class="epydoc">Class ArchivePreBuilder</h1><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder">source code</a></span><br /><br /> |
|
57 <pre class="base-tree"> |
|
58 object --+ |
|
59 | |
|
60 <a href="buildtools.PreBuilder-class.html">buildtools.PreBuilder</a> --+ |
|
61 | |
|
62 <strong class="uidshort">ArchivePreBuilder</strong> |
|
63 </pre> |
|
64 |
|
65 <hr /> |
|
66 Processes an archive build specification.<br /><br /> |
|
67 |
|
68 <!-- ==================== INSTANCE METHODS ==================== --> |
|
69 <a name="section-InstanceMethods"></a> |
|
70 <table class="summary" border="1" cellpadding="3" |
|
71 cellspacing="0" width="100%" bgcolor="white"> |
|
72 <tr bgcolor="#70b0f0" class="table-header"> |
|
73 <td colspan="2" class="table-header"> |
|
74 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
75 <tr valign="top"> |
|
76 <td align="left"><span class="table-header">Instance Methods</span></td> |
|
77 <td align="right" valign="top" |
|
78 ><span class="options">[<a href="#section-InstanceMethods" |
|
79 class="privatelink" onclick="toggle_private();" |
|
80 >hide private</a>]</span></td> |
|
81 </tr> |
|
82 </table> |
|
83 </td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td width="15%" align="right" valign="top" class="summary"> |
|
87 <span class="summary-type"> </span> |
|
88 </td><td class="summary"> |
|
89 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
90 <tr> |
|
91 <td><span class="summary-sig"><a href="archive.builders.ArchivePreBuilder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
92 <span class="summary-sig-arg">config_set</span>, |
|
93 <span class="summary-sig-arg">config_name</span>, |
|
94 <span class="summary-sig-arg">writerType</span>=<span class="summary-sig-default">'ant'</span>, |
|
95 <span class="summary-sig-arg">index</span>=<span class="summary-sig-default">None</span>)</span></td> |
|
96 <td align="right" valign="top"> |
|
97 <span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.__init__">source code</a></span> |
|
98 |
|
99 </td> |
|
100 </tr> |
|
101 </table> |
|
102 |
|
103 </td> |
|
104 </tr> |
|
105 <tr> |
|
106 <td width="15%" align="right" valign="top" class="summary"> |
|
107 <span class="summary-type"> </span> |
|
108 </td><td class="summary"> |
|
109 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
110 <tr> |
|
111 <td><span class="summary-sig"><a name="build_manifest"></a><span class="summary-sig-name">build_manifest</span>(<span class="summary-sig-arg">self</span>, |
|
112 <span class="summary-sig-arg">config</span>)</span><br /> |
|
113 Generate a manifest file from the a configuration.</td> |
|
114 <td align="right" valign="top"> |
|
115 <span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.build_manifest">source code</a></span> |
|
116 |
|
117 </td> |
|
118 </tr> |
|
119 </table> |
|
120 |
|
121 </td> |
|
122 </tr> |
|
123 <tr> |
|
124 <td width="15%" align="right" valign="top" class="summary"> |
|
125 <span class="summary-type"> </span> |
|
126 </td><td class="summary"> |
|
127 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
128 <tr> |
|
129 <td><span class="summary-sig"><a href="archive.builders.ArchivePreBuilder-class.html#manifest_to_commands" class="summary-sig-name">manifest_to_commands</a>(<span class="summary-sig-arg">self</span>, |
|
130 <span class="summary-sig-arg">config</span>, |
|
131 <span class="summary-sig-arg">manifest</span>)</span><br /> |
|
132 Generate return a command list.</td> |
|
133 <td align="right" valign="top"> |
|
134 <span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.manifest_to_commands">source code</a></span> |
|
135 |
|
136 </td> |
|
137 </tr> |
|
138 </table> |
|
139 |
|
140 </td> |
|
141 </tr> |
|
142 <tr> |
|
143 <td width="15%" align="right" valign="top" class="summary"> |
|
144 <span class="summary-type"> </span> |
|
145 </td><td class="summary"> |
|
146 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
147 <tr> |
|
148 <td><span class="summary-sig"><a name="create_command_list"></a><span class="summary-sig-name">create_command_list</span>(<span class="summary-sig-arg">self</span>, |
|
149 <span class="summary-sig-arg">commands</span>)</span><br /> |
|
150 Convert a two dimensions array of command to a CommandList object.</td> |
|
151 <td align="right" valign="top"> |
|
152 <span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.create_command_list">source code</a></span> |
|
153 |
|
154 </td> |
|
155 </tr> |
|
156 </table> |
|
157 |
|
158 </td> |
|
159 </tr> |
|
160 <tr> |
|
161 <td width="15%" align="right" valign="top" class="summary"> |
|
162 <span class="summary-type"> </span> |
|
163 </td><td class="summary"> |
|
164 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
165 <tr> |
|
166 <td><span class="summary-sig"><a name="writeTopLevel"></a><span class="summary-sig-name">writeTopLevel</span>(<span class="summary-sig-arg">self</span>, |
|
167 <span class="summary-sig-arg">build_file_path</span>, |
|
168 <span class="summary-sig-arg">output_path</span>, |
|
169 <span class="summary-sig-arg">xml_file</span>)</span><br /> |
|
170 Creates a build tool config makefile that executes archieve build.</td> |
|
171 <td align="right" valign="top"> |
|
172 <span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.writeTopLevel">source code</a></span> |
|
173 |
|
174 </td> |
|
175 </tr> |
|
176 </table> |
|
177 |
|
178 </td> |
|
179 </tr> |
|
180 <tr> |
|
181 <td width="15%" align="right" valign="top" class="summary"> |
|
182 <span class="summary-type"> </span> |
|
183 </td><td class="summary"> |
|
184 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
185 <tr> |
|
186 <td><span class="summary-sig"><a href="archive.builders.ArchivePreBuilder-class.html#write" class="summary-sig-name">write</a>(<span class="summary-sig-arg">self</span>, |
|
187 <span class="summary-sig-arg">outputname</span>)</span><br /> |
|
188 Creates a build tool configuration file that executes archive build operations.</td> |
|
189 <td align="right" valign="top"> |
|
190 <span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.write">source code</a></span> |
|
191 |
|
192 </td> |
|
193 </tr> |
|
194 </table> |
|
195 |
|
196 </td> |
|
197 </tr> |
|
198 <tr> |
|
199 <td colspan="2" class="summary"> |
|
200 <p class="indent-wrapped-lines"><b>Inherited from <code><a href="buildtools.PreBuilder-class.html">buildtools.PreBuilder</a></code></b>: |
|
201 <code><a href="buildtools.PreBuilder-class.html#writeBuildFile">writeBuildFile</a></code> |
|
202 </p> |
|
203 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
204 <code>__delattr__</code>, |
|
205 <code>__getattribute__</code>, |
|
206 <code>__hash__</code>, |
|
207 <code>__new__</code>, |
|
208 <code>__reduce__</code>, |
|
209 <code>__reduce_ex__</code>, |
|
210 <code>__repr__</code>, |
|
211 <code>__setattr__</code>, |
|
212 <code>__str__</code> |
|
213 </p> |
|
214 </td> |
|
215 </tr> |
|
216 </table> |
|
217 <!-- ==================== PROPERTIES ==================== --> |
|
218 <a name="section-Properties"></a> |
|
219 <table class="summary" border="1" cellpadding="3" |
|
220 cellspacing="0" width="100%" bgcolor="white"> |
|
221 <tr bgcolor="#70b0f0" class="table-header"> |
|
222 <td colspan="2" class="table-header"> |
|
223 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
224 <tr valign="top"> |
|
225 <td align="left"><span class="table-header">Properties</span></td> |
|
226 <td align="right" valign="top" |
|
227 ><span class="options">[<a href="#section-Properties" |
|
228 class="privatelink" onclick="toggle_private();" |
|
229 >hide private</a>]</span></td> |
|
230 </tr> |
|
231 </table> |
|
232 </td> |
|
233 </tr> |
|
234 <tr> |
|
235 <td colspan="2" class="summary"> |
|
236 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
237 <code>__class__</code> |
|
238 </p> |
|
239 </td> |
|
240 </tr> |
|
241 </table> |
|
242 <!-- ==================== METHOD DETAILS ==================== --> |
|
243 <a name="section-MethodDetails"></a> |
|
244 <table class="details" border="1" cellpadding="3" |
|
245 cellspacing="0" width="100%" bgcolor="white"> |
|
246 <tr bgcolor="#70b0f0" class="table-header"> |
|
247 <td colspan="2" class="table-header"> |
|
248 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
249 <tr valign="top"> |
|
250 <td align="left"><span class="table-header">Method Details</span></td> |
|
251 <td align="right" valign="top" |
|
252 ><span class="options">[<a href="#section-MethodDetails" |
|
253 class="privatelink" onclick="toggle_private();" |
|
254 >hide private</a>]</span></td> |
|
255 </tr> |
|
256 </table> |
|
257 </td> |
|
258 </tr> |
|
259 </table> |
|
260 <a name="__init__"></a> |
|
261 <div> |
|
262 <table class="details" border="1" cellpadding="3" |
|
263 cellspacing="0" width="100%" bgcolor="white"> |
|
264 <tr><td> |
|
265 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
266 <tr valign="top"><td> |
|
267 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
268 <span class="sig-arg">config_set</span>, |
|
269 <span class="sig-arg">config_name</span>, |
|
270 <span class="sig-arg">writerType</span>=<span class="sig-default">'ant'</span>, |
|
271 <span class="sig-arg">index</span>=<span class="sig-default">None</span>)</span> |
|
272 <br /><em class="fname">(Constructor)</em> |
|
273 </h3> |
|
274 </td><td align="right" valign="top" |
|
275 ><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.__init__">source code</a></span> |
|
276 </td> |
|
277 </table> |
|
278 |
|
279 |
|
280 <dl class="fields"> |
|
281 <dt>Overrides: |
|
282 <a href="buildtools.PreBuilder-class.html#__init__">buildtools.PreBuilder.__init__</a> |
|
283 </dt> |
|
284 </dl> |
|
285 </td></tr></table> |
|
286 </div> |
|
287 <a name="manifest_to_commands"></a> |
|
288 <div> |
|
289 <table class="details" border="1" cellpadding="3" |
|
290 cellspacing="0" width="100%" bgcolor="white"> |
|
291 <tr><td> |
|
292 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
293 <tr valign="top"><td> |
|
294 <h3 class="epydoc"><span class="sig"><span class="sig-name">manifest_to_commands</span>(<span class="sig-arg">self</span>, |
|
295 <span class="sig-arg">config</span>, |
|
296 <span class="sig-arg">manifest</span>)</span> |
|
297 </h3> |
|
298 </td><td align="right" valign="top" |
|
299 ><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.manifest_to_commands">source code</a></span> |
|
300 </td> |
|
301 </table> |
|
302 |
|
303 Generate return a command list. Commands are stored in a two dimension array. |
|
304 <dl class="fields"> |
|
305 </dl> |
|
306 </td></tr></table> |
|
307 </div> |
|
308 <a name="write"></a> |
|
309 <div> |
|
310 <table class="details" border="1" cellpadding="3" |
|
311 cellspacing="0" width="100%" bgcolor="white"> |
|
312 <tr><td> |
|
313 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
314 <tr valign="top"><td> |
|
315 <h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>, |
|
316 <span class="sig-arg">outputname</span>)</span> |
|
317 </h3> |
|
318 </td><td align="right" valign="top" |
|
319 ><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.write">source code</a></span> |
|
320 </td> |
|
321 </table> |
|
322 |
|
323 <p>Creates a build tool configuration file that executes archive build operations.</p> |
|
324 <p>The input to each archive build operation is an includefile that lists |
|
325 all the files to be included in the archive. These text files are |
|
326 generated before the build file by scanning the filesystem.</p> |
|
327 <dl class="fields"> |
|
328 </dl> |
|
329 </td></tr></table> |
|
330 </div> |
|
331 <br /> |
|
332 <!-- ==================== NAVIGATION BAR ==================== --> |
|
333 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
334 bgcolor="#a0c0ff" cellspacing="0"> |
|
335 <tr valign="middle"> |
|
336 |
|
337 <!-- Tree link --> |
|
338 <th> <a |
|
339 href="module-tree.html">Trees</a> </th> |
|
340 |
|
341 <!-- Index link --> |
|
342 <th> <a |
|
343 href="identifier-index.html">Indices</a> </th> |
|
344 |
|
345 <!-- Help link --> |
|
346 <th> <a |
|
347 href="help.html">Help</a> </th> |
|
348 |
|
349 <th class="navbar" width="100%"></th> |
|
350 </tr> |
|
351 </table> |
|
352 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
353 <tr> |
|
354 <td align="left" class="footer"> |
|
355 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009 |
|
356 </td> |
|
357 <td align="right" class="footer"> |
|
358 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
359 </td> |
|
360 </tr> |
|
361 </table> |
|
362 |
|
363 <script type="text/javascript"> |
|
364 <!-- |
|
365 // Private objects are initially displayed (because if |
|
366 // javascript is turned off then we want them to be |
|
367 // visible); but by default, we want to hide them. So hide |
|
368 // them unless we have a cookie that says to show them. |
|
369 checkCookie() |
|
370 // --> |
|
371 </script> |
|
372 |
|
373 </body> |
|
374 </html> |