Wrote a script to extract data for e32tests & f32tests based on input from:
richardcoles / Symbian Foundation Community Member
and
Krishna Achugatla from Symbian.
<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>archive.builders.ArchivePreBuilder</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="archive-module.html">Package archive</a> ::
<a href="archive.builders-module.html">Module builders</a> ::
Class ArchivePreBuilder
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
onclick="toggle_private();">hide private</a>]</span></td></tr>
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="archive.builders.ArchivePreBuilder-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ArchivePreBuilder</h1><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder">source code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<a href="buildtools.PreBuilder-class.html">buildtools.PreBuilder</a> --+
|
<strong class="uidshort">ArchivePreBuilder</strong>
</pre>
<hr />
Processes an archive build specification.<br /><br />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Instance Methods</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-InstanceMethods"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">config_set</span>,
<span class="summary-sig-arg">config_name</span>,
<span class="summary-sig-arg">writerType</span>=<span class="summary-sig-default">'ant'</span>,
<span class="summary-sig-arg">index</span>=<span class="summary-sig-default">None</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">config</span>)</span><br />
Generate a manifest file from the a configuration.</td>
<td align="right" valign="top">
<span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.build_manifest">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">config</span>,
<span class="summary-sig-arg">manifest</span>)</span><br />
Generate return a command list.</td>
<td align="right" valign="top">
<span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.manifest_to_commands">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">commands</span>)</span><br />
Convert a two dimensions array of command to a CommandList object.</td>
<td align="right" valign="top">
<span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.create_command_list">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="writeTopLevel"></a><span class="summary-sig-name">writeTopLevel</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">build_file_path</span>,
<span class="summary-sig-arg">output_path</span>,
<span class="summary-sig-arg">xml_file</span>)</span><br />
Creates a build tool config makefile that executes archieve build.</td>
<td align="right" valign="top">
<span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.writeTopLevel">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<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>,
<span class="summary-sig-arg">outputname</span>)</span><br />
Creates a build tool configuration file that executes archive build operations.</td>
<td align="right" valign="top">
<span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.write">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="buildtools.PreBuilder-class.html">buildtools.PreBuilder</a></code></b>:
<code><a href="buildtools.PreBuilder-class.html#writeBuildFile">writeBuildFile</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Properties</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-Properties"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td colspan="2" class="table-header">
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr valign="top">
<td align="left"><span class="table-header">Method Details</span></td>
<td align="right" valign="top"
><span class="options">[<a href="#section-MethodDetails"
class="privatelink" onclick="toggle_private();"
>hide private</a>]</span></td>
</tr>
</table>
</td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">config_set</span>,
<span class="sig-arg">config_name</span>,
<span class="sig-arg">writerType</span>=<span class="sig-default">'ant'</span>,
<span class="sig-arg">index</span>=<span class="sig-default">None</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.__init__">source code</a></span>
</td>
</table>
<dl class="fields">
<dt>Overrides:
<a href="buildtools.PreBuilder-class.html#__init__">buildtools.PreBuilder.__init__</a>
</dt>
</dl>
</td></tr></table>
</div>
<a name="manifest_to_commands"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">manifest_to_commands</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">config</span>,
<span class="sig-arg">manifest</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.manifest_to_commands">source code</a></span>
</td>
</table>
Generate return a command list. Commands are stored in a two dimension array.
<dl class="fields">
</dl>
</td></tr></table>
</div>
<a name="write"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">write</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">outputname</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="archive.builders-pysrc.html#ArchivePreBuilder.write">source code</a></span>
</td>
</table>
<p>Creates a build tool configuration file that executes archive build operations.</p>
<p>The input to each archive build operation is an includefile that lists
all the files to be included in the archive. These text files are
generated before the build file by scanning the filesystem.</p>
<dl class="fields">
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<th class="navbar" width="100%"></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:16 2009
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>