|
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.Image</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="rom-module.html">Module rom</a> :: |
|
38 Class Image |
|
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="rom.Image-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 Image</h1><span class="codelink"><a href="rom-pysrc.html#Image">source code</a></span><br /><br /> |
|
56 An Image object represents a ROM image, or .fpsx file.<br /><br /> |
|
57 |
|
58 <!-- ==================== INSTANCE METHODS ==================== --> |
|
59 <a name="section-InstanceMethods"></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">Instance Methods</span></td> |
|
67 <td align="right" valign="top" |
|
68 ><span class="options">[<a href="#section-InstanceMethods" |
|
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 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
80 <tr> |
|
81 <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>, |
|
82 <span class="summary-sig-arg">config</span>)</span><br /> |
|
83 Initialise the Image object.</td> |
|
84 <td align="right" valign="top"> |
|
85 <span class="codelink"><a href="rom-pysrc.html#Image.__init__">source code</a></span> |
|
86 |
|
87 </td> |
|
88 </tr> |
|
89 </table> |
|
90 |
|
91 </td> |
|
92 </tr> |
|
93 <tr> |
|
94 <td width="15%" align="right" valign="top" class="summary"> |
|
95 <span class="summary-type"> </span> |
|
96 </td><td class="summary"> |
|
97 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
98 <tr> |
|
99 <td><span class="summary-sig"><a name="build"></a><span class="summary-sig-name">build</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
100 Main method that handles the whole sequence of building the rom and |
|
101 moving all related files to the correct location.</td> |
|
102 <td align="right" valign="top"> |
|
103 <span class="codelink"><a href="rom-pysrc.html#Image.build">source code</a></span> |
|
104 |
|
105 </td> |
|
106 </tr> |
|
107 </table> |
|
108 |
|
109 </td> |
|
110 </tr> |
|
111 <tr class="private"> |
|
112 <td width="15%" align="right" valign="top" class="summary"> |
|
113 <span class="summary-type"> </span> |
|
114 </td><td class="summary"> |
|
115 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
116 <tr> |
|
117 <td><span class="summary-sig"><a name="_create_destination"></a><span class="summary-sig-name">_create_destination</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
118 Creates the destination directory of the ROM files if it does not exist.</td> |
|
119 <td align="right" valign="top"> |
|
120 <span class="codelink"><a href="rom-pysrc.html#Image._create_destination">source code</a></span> |
|
121 |
|
122 </td> |
|
123 </tr> |
|
124 </table> |
|
125 |
|
126 </td> |
|
127 </tr> |
|
128 <tr class="private"> |
|
129 <td width="15%" align="right" valign="top" class="summary"> |
|
130 <span class="summary-type"> </span> |
|
131 </td><td class="summary"> |
|
132 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
133 <tr> |
|
134 <td><span class="summary-sig"><a name="_process_cmt"></a><span class="summary-sig-name">_process_cmt</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
135 Copies the CMT image under epoc32 and to the destination directory of |
|
136 the ROM image, if the image will include the CMT.</td> |
|
137 <td align="right" valign="top"> |
|
138 <span class="codelink"><a href="rom-pysrc.html#Image._process_cmt">source code</a></span> |
|
139 |
|
140 </td> |
|
141 </tr> |
|
142 </table> |
|
143 |
|
144 </td> |
|
145 </tr> |
|
146 <tr class="private"> |
|
147 <td width="15%" align="right" valign="top" class="summary"> |
|
148 <span class="summary-type"> </span> |
|
149 </td><td class="summary"> |
|
150 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
151 <tr> |
|
152 <td><span class="summary-sig"><a href="rom.Image-class.html#_write_version" class="summary-sig-name">_write_version</a>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
153 Generates the version text files that define the version of the ROM image.</td> |
|
154 <td align="right" valign="top"> |
|
155 <span class="codelink"><a href="rom-pysrc.html#Image._write_version">source code</a></span> |
|
156 |
|
157 </td> |
|
158 </tr> |
|
159 </table> |
|
160 |
|
161 </td> |
|
162 </tr> |
|
163 <tr class="private"> |
|
164 <td width="15%" align="right" valign="top" class="summary"> |
|
165 <span class="summary-type"> </span> |
|
166 </td><td class="summary"> |
|
167 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
168 <tr> |
|
169 <td><span class="summary-sig"><a name="_process_my_traces"></a><span class="summary-sig-name">_process_my_traces</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
170 Generates a mytraces.txt file under epoc32 based on the <mytraces/> |
|
171 XML sub-elements defined for the image.</td> |
|
172 <td align="right" valign="top"> |
|
173 <span class="codelink"><a href="rom-pysrc.html#Image._process_my_traces">source code</a></span> |
|
174 |
|
175 </td> |
|
176 </tr> |
|
177 </table> |
|
178 |
|
179 </td> |
|
180 </tr> |
|
181 <tr class="private"> |
|
182 <td width="15%" align="right" valign="top" class="summary"> |
|
183 <span class="summary-type"> </span> |
|
184 </td><td class="summary"> |
|
185 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
186 <tr> |
|
187 <td><span class="summary-sig"><a name="_callrommake"></a><span class="summary-sig-name">_callrommake</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
188 Calls the make_fpsx.cmd to build a ROM image.</td> |
|
189 <td align="right" valign="top"> |
|
190 <span class="codelink"><a href="rom-pysrc.html#Image._callrommake">source code</a></span> |
|
191 |
|
192 </td> |
|
193 </tr> |
|
194 </table> |
|
195 |
|
196 </td> |
|
197 </tr> |
|
198 <tr class="private"> |
|
199 <td width="15%" align="right" valign="top" class="summary"> |
|
200 <span class="summary-type"> </span> |
|
201 </td><td class="summary"> |
|
202 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
203 <tr> |
|
204 <td><span class="summary-sig"><a name="_clean_mytraces"></a><span class="summary-sig-name">_clean_mytraces</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
205 <td align="right" valign="top"> |
|
206 <span class="codelink"><a href="rom-pysrc.html#Image._clean_mytraces">source code</a></span> |
|
207 |
|
208 </td> |
|
209 </tr> |
|
210 </table> |
|
211 |
|
212 </td> |
|
213 </tr> |
|
214 <tr class="private"> |
|
215 <td width="15%" align="right" valign="top" class="summary"> |
|
216 <span class="summary-type"> </span> |
|
217 </td><td class="summary"> |
|
218 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
219 <tr> |
|
220 <td><span class="summary-sig"><a name="_move_image_files"></a><span class="summary-sig-name">_move_image_files</span>(<span class="summary-sig-arg">self</span>)</span></td> |
|
221 <td align="right" valign="top"> |
|
222 <span class="codelink"><a href="rom-pysrc.html#Image._move_image_files">source code</a></span> |
|
223 |
|
224 </td> |
|
225 </tr> |
|
226 </table> |
|
227 |
|
228 </td> |
|
229 </tr> |
|
230 <tr> |
|
231 <td width="15%" align="right" valign="top" class="summary"> |
|
232 <span class="summary-type"> </span> |
|
233 </td><td class="summary"> |
|
234 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
235 <tr> |
|
236 <td><span class="summary-sig"><a name="__str__"></a><span class="summary-sig-name">__str__</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
237 Returns the filename of the image file once copied to the |
|
238 *_flash_images directory.</td> |
|
239 <td align="right" valign="top"> |
|
240 <span class="codelink"><a href="rom-pysrc.html#Image.__str__">source code</a></span> |
|
241 |
|
242 </td> |
|
243 </tr> |
|
244 </table> |
|
245 |
|
246 </td> |
|
247 </tr> |
|
248 </table> |
|
249 <!-- ==================== METHOD DETAILS ==================== --> |
|
250 <a name="section-MethodDetails"></a> |
|
251 <table class="details" border="1" cellpadding="3" |
|
252 cellspacing="0" width="100%" bgcolor="white"> |
|
253 <tr bgcolor="#70b0f0" class="table-header"> |
|
254 <td colspan="2" class="table-header"> |
|
255 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
256 <tr valign="top"> |
|
257 <td align="left"><span class="table-header">Method Details</span></td> |
|
258 <td align="right" valign="top" |
|
259 ><span class="options">[<a href="#section-MethodDetails" |
|
260 class="privatelink" onclick="toggle_private();" |
|
261 >hide private</a>]</span></td> |
|
262 </tr> |
|
263 </table> |
|
264 </td> |
|
265 </tr> |
|
266 </table> |
|
267 <a name="_write_version"></a> |
|
268 <div class="private"> |
|
269 <table class="details" border="1" cellpadding="3" |
|
270 cellspacing="0" width="100%" bgcolor="white"> |
|
271 <tr><td> |
|
272 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
273 <tr valign="top"><td> |
|
274 <h3 class="epydoc"><span class="sig"><span class="sig-name">_write_version</span>(<span class="sig-arg">self</span>)</span> |
|
275 </h3> |
|
276 </td><td align="right" valign="top" |
|
277 ><span class="codelink"><a href="rom-pysrc.html#Image._write_version">source code</a></span> |
|
278 </td> |
|
279 </table> |
|
280 |
|
281 Generates the version text files that define the version of the ROM image. |
|
282 These are in UTF16 little endian (Symbian) format. |
|
283 <dl class="fields"> |
|
284 </dl> |
|
285 </td></tr></table> |
|
286 </div> |
|
287 <br /> |
|
288 <!-- ==================== NAVIGATION BAR ==================== --> |
|
289 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
290 bgcolor="#a0c0ff" cellspacing="0"> |
|
291 <tr valign="middle"> |
|
292 |
|
293 <!-- Tree link --> |
|
294 <th> <a |
|
295 href="module-tree.html">Trees</a> </th> |
|
296 |
|
297 <!-- Index link --> |
|
298 <th> <a |
|
299 href="identifier-index.html">Indices</a> </th> |
|
300 |
|
301 <!-- Help link --> |
|
302 <th> <a |
|
303 href="help.html">Help</a> </th> |
|
304 |
|
305 <th class="navbar" width="100%"></th> |
|
306 </tr> |
|
307 </table> |
|
308 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
309 <tr> |
|
310 <td align="left" class="footer"> |
|
311 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:19 2009 |
|
312 </td> |
|
313 <td align="right" class="footer"> |
|
314 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
315 </td> |
|
316 </tr> |
|
317 </table> |
|
318 |
|
319 <script type="text/javascript"> |
|
320 <!-- |
|
321 // Private objects are initially displayed (because if |
|
322 // javascript is turned off then we want them to be |
|
323 // visible); but by default, we want to hide them. So hide |
|
324 // them unless we have a cookie that says to show them. |
|
325 checkCookie() |
|
326 // --> |
|
327 </script> |
|
328 |
|
329 </body> |
|
330 </html> |