|
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>bsf.BSF</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="bsf-module.html">Module bsf</a> :: |
|
38 Class BSF |
|
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="bsf.BSF-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 BSF</h1><span class="codelink"><a href="bsf-pysrc.html#BSF">source code</a></span><br /><br /> |
|
56 <pre class="base-tree"> |
|
57 object --+ |
|
58 | |
|
59 <strong class="uidshort">BSF</strong> |
|
60 </pre> |
|
61 |
|
62 <hr /> |
|
63 Class that parse and abstract a bsf file.<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="bsf.BSF-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>, |
|
89 <span class="summary-sig-arg">filename</span>, |
|
90 <span class="summary-sig-arg">bsflist</span>)</span><br /> |
|
91 x.__init__(...) initializes x; see x.__class__.__doc__ for signature</td> |
|
92 <td align="right" valign="top"> |
|
93 <span class="codelink"><a href="bsf-pysrc.html#BSF.__init__">source code</a></span> |
|
94 |
|
95 </td> |
|
96 </tr> |
|
97 </table> |
|
98 |
|
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="parse"></a><span class="summary-sig-name">parse</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
108 Parse the bsf file</td> |
|
109 <td align="right" valign="top"> |
|
110 <span class="codelink"><a href="bsf-pysrc.html#BSF.parse">source code</a></span> |
|
111 |
|
112 </td> |
|
113 </tr> |
|
114 </table> |
|
115 |
|
116 </td> |
|
117 </tr> |
|
118 <tr> |
|
119 <td width="15%" align="right" valign="top" class="summary"> |
|
120 <span class="summary-type"> </span> |
|
121 </td><td class="summary"> |
|
122 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
123 <tr> |
|
124 <td><span class="summary-sig"><a name="is_variant"></a><span class="summary-sig-name">is_variant</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
125 I am a variant</td> |
|
126 <td align="right" valign="top"> |
|
127 <span class="codelink"><a href="bsf-pysrc.html#BSF.is_variant">source code</a></span> |
|
128 |
|
129 </td> |
|
130 </tr> |
|
131 </table> |
|
132 |
|
133 </td> |
|
134 </tr> |
|
135 <tr> |
|
136 <td width="15%" align="right" valign="top" class="summary"> |
|
137 <span class="summary-type"> </span> |
|
138 </td><td class="summary"> |
|
139 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
140 <tr> |
|
141 <td><span class="summary-sig"><a name="is_virtual_variant"></a><span class="summary-sig-name">is_virtual_variant</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
142 I am a virtual variant</td> |
|
143 <td align="right" valign="top"> |
|
144 <span class="codelink"><a href="bsf-pysrc.html#BSF.is_virtual_variant">source code</a></span> |
|
145 |
|
146 </td> |
|
147 </tr> |
|
148 </table> |
|
149 |
|
150 </td> |
|
151 </tr> |
|
152 <tr> |
|
153 <td width="15%" align="right" valign="top" class="summary"> |
|
154 <span class="summary-type"> </span> |
|
155 </td><td class="summary"> |
|
156 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
157 <tr> |
|
158 <td><span class="summary-sig"><a name="customize"></a><span class="summary-sig-name">customize</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
159 who am I customizing?</td> |
|
160 <td align="right" valign="top"> |
|
161 <span class="codelink"><a href="bsf-pysrc.html#BSF.customize">source code</a></span> |
|
162 |
|
163 </td> |
|
164 </tr> |
|
165 </table> |
|
166 |
|
167 </td> |
|
168 </tr> |
|
169 <tr> |
|
170 <td width="15%" align="right" valign="top" class="summary"> |
|
171 <span class="summary-type"> </span> |
|
172 </td><td class="summary"> |
|
173 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
174 <tr> |
|
175 <td><span class="summary-sig"><a name="compile_with_parent"></a><span class="summary-sig-name">compile_with_parent</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
176 who am I customizing?</td> |
|
177 <td align="right" valign="top"> |
|
178 <span class="codelink"><a href="bsf-pysrc.html#BSF.compile_with_parent">source code</a></span> |
|
179 |
|
180 </td> |
|
181 </tr> |
|
182 </table> |
|
183 |
|
184 </td> |
|
185 </tr> |
|
186 <tr> |
|
187 <td width="15%" align="right" valign="top" class="summary"> |
|
188 <span class="summary-type"> </span> |
|
189 </td><td class="summary"> |
|
190 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
191 <tr> |
|
192 <td><span class="summary-sig"><a name="get_name"></a><span class="summary-sig-name">get_name</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
193 get my name...</td> |
|
194 <td align="right" valign="top"> |
|
195 <span class="codelink"><a href="bsf-pysrc.html#BSF.get_name">source code</a></span> |
|
196 |
|
197 </td> |
|
198 </tr> |
|
199 </table> |
|
200 |
|
201 </td> |
|
202 </tr> |
|
203 <tr> |
|
204 <td width="15%" align="right" valign="top" class="summary"> |
|
205 <span class="summary-type"> </span> |
|
206 </td><td class="summary"> |
|
207 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
208 <tr> |
|
209 <td><span class="summary-sig"><a name="get_path_as_array"></a><span class="summary-sig-name">get_path_as_array</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
210 return myself plus my parents</td> |
|
211 <td align="right" valign="top"> |
|
212 <span class="codelink"><a href="bsf-pysrc.html#BSF.get_path_as_array">source code</a></span> |
|
213 |
|
214 </td> |
|
215 </tr> |
|
216 </table> |
|
217 |
|
218 </td> |
|
219 </tr> |
|
220 <tr> |
|
221 <td width="15%" align="right" valign="top" class="summary"> |
|
222 <span class="summary-type"> </span> |
|
223 </td><td class="summary"> |
|
224 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
225 <tr> |
|
226 <td><span class="summary-sig"><a name="get_path"></a><span class="summary-sig-name">get_path</span>(<span class="summary-sig-arg">self</span>)</span><br /> |
|
227 return the path section</td> |
|
228 <td align="right" valign="top"> |
|
229 <span class="codelink"><a href="bsf-pysrc.html#BSF.get_path">source code</a></span> |
|
230 |
|
231 </td> |
|
232 </tr> |
|
233 </table> |
|
234 |
|
235 </td> |
|
236 </tr> |
|
237 <tr> |
|
238 <td colspan="2" class="summary"> |
|
239 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
240 <code>__delattr__</code>, |
|
241 <code>__getattribute__</code>, |
|
242 <code>__hash__</code>, |
|
243 <code>__new__</code>, |
|
244 <code>__reduce__</code>, |
|
245 <code>__reduce_ex__</code>, |
|
246 <code>__repr__</code>, |
|
247 <code>__setattr__</code>, |
|
248 <code>__str__</code> |
|
249 </p> |
|
250 </td> |
|
251 </tr> |
|
252 </table> |
|
253 <!-- ==================== PROPERTIES ==================== --> |
|
254 <a name="section-Properties"></a> |
|
255 <table class="summary" border="1" cellpadding="3" |
|
256 cellspacing="0" width="100%" bgcolor="white"> |
|
257 <tr bgcolor="#70b0f0" class="table-header"> |
|
258 <td colspan="2" class="table-header"> |
|
259 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
260 <tr valign="top"> |
|
261 <td align="left"><span class="table-header">Properties</span></td> |
|
262 <td align="right" valign="top" |
|
263 ><span class="options">[<a href="#section-Properties" |
|
264 class="privatelink" onclick="toggle_private();" |
|
265 >hide private</a>]</span></td> |
|
266 </tr> |
|
267 </table> |
|
268 </td> |
|
269 </tr> |
|
270 <tr> |
|
271 <td colspan="2" class="summary"> |
|
272 <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>: |
|
273 <code>__class__</code> |
|
274 </p> |
|
275 </td> |
|
276 </tr> |
|
277 </table> |
|
278 <!-- ==================== METHOD DETAILS ==================== --> |
|
279 <a name="section-MethodDetails"></a> |
|
280 <table class="details" border="1" cellpadding="3" |
|
281 cellspacing="0" width="100%" bgcolor="white"> |
|
282 <tr bgcolor="#70b0f0" class="table-header"> |
|
283 <td colspan="2" class="table-header"> |
|
284 <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
|
285 <tr valign="top"> |
|
286 <td align="left"><span class="table-header">Method Details</span></td> |
|
287 <td align="right" valign="top" |
|
288 ><span class="options">[<a href="#section-MethodDetails" |
|
289 class="privatelink" onclick="toggle_private();" |
|
290 >hide private</a>]</span></td> |
|
291 </tr> |
|
292 </table> |
|
293 </td> |
|
294 </tr> |
|
295 </table> |
|
296 <a name="__init__"></a> |
|
297 <div> |
|
298 <table class="details" border="1" cellpadding="3" |
|
299 cellspacing="0" width="100%" bgcolor="white"> |
|
300 <tr><td> |
|
301 <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
|
302 <tr valign="top"><td> |
|
303 <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>, |
|
304 <span class="sig-arg">filename</span>, |
|
305 <span class="sig-arg">bsflist</span>)</span> |
|
306 <br /><em class="fname">(Constructor)</em> |
|
307 </h3> |
|
308 </td><td align="right" valign="top" |
|
309 ><span class="codelink"><a href="bsf-pysrc.html#BSF.__init__">source code</a></span> |
|
310 </td> |
|
311 </table> |
|
312 |
|
313 x.__init__(...) initializes x; see x.__class__.__doc__ for signature |
|
314 <dl class="fields"> |
|
315 <dt>Overrides: |
|
316 object.__init__ |
|
317 <dd><em class="note">(inherited documentation)</em></dd> |
|
318 </dt> |
|
319 </dl> |
|
320 </td></tr></table> |
|
321 </div> |
|
322 <br /> |
|
323 <!-- ==================== NAVIGATION BAR ==================== --> |
|
324 <table class="navbar" border="0" width="100%" cellpadding="0" |
|
325 bgcolor="#a0c0ff" cellspacing="0"> |
|
326 <tr valign="middle"> |
|
327 |
|
328 <!-- Tree link --> |
|
329 <th> <a |
|
330 href="module-tree.html">Trees</a> </th> |
|
331 |
|
332 <!-- Index link --> |
|
333 <th> <a |
|
334 href="identifier-index.html">Indices</a> </th> |
|
335 |
|
336 <!-- Help link --> |
|
337 <th> <a |
|
338 href="help.html">Help</a> </th> |
|
339 |
|
340 <th class="navbar" width="100%"></th> |
|
341 </tr> |
|
342 </table> |
|
343 <table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
|
344 <tr> |
|
345 <td align="left" class="footer"> |
|
346 Generated by Epydoc 3.0beta1 on Wed Sep 09 13:44:17 2009 |
|
347 </td> |
|
348 <td align="right" class="footer"> |
|
349 <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a> |
|
350 </td> |
|
351 </tr> |
|
352 </table> |
|
353 |
|
354 <script type="text/javascript"> |
|
355 <!-- |
|
356 // Private objects are initially displayed (because if |
|
357 // javascript is turned off then we want them to be |
|
358 // visible); but by default, we want to hide them. So hide |
|
359 // them unless we have a cookie that says to show them. |
|
360 checkCookie() |
|
361 // --> |
|
362 </script> |
|
363 |
|
364 </body> |
|
365 </html> |