16 |
16 |
17 a { color: #BA6D36; } |
17 a { color: #BA6D36; } |
18 |
18 |
19 </style> |
19 </style> |
20 </head> |
20 </head> |
21 <body><a NAME="top" ID="top"></a> |
21 <body> |
|
22 <a NAME="top" ID="top"></a> |
22 <h1>eric6.Utilities.ClassBrowsers.idlclbr</h1> |
23 <h1>eric6.Utilities.ClassBrowsers.idlclbr</h1> |
|
24 |
23 <p> |
25 <p> |
24 Parse a CORBA IDL file and retrieve modules, interfaces, methods and |
26 Parse a CORBA IDL file and retrieve modules, interfaces, methods and |
25 attributes. |
27 attributes. |
26 </p><p> |
28 </p> |
|
29 <p> |
27 Parse enough of a CORBA IDL file to recognize module, interface and method |
30 Parse enough of a CORBA IDL file to recognize module, interface and method |
28 definitions and to find out the superclasses of an interface as well as its |
31 definitions and to find out the superclasses of an interface as well as its |
29 attributes. |
32 attributes. |
30 </p><p> |
33 </p> |
|
34 <p> |
31 It is based on the Python class browser found in this package. |
35 It is based on the Python class browser found in this package. |
32 </p> |
36 </p> |
33 <h3>Global Attributes</h3> |
37 <h3>Global Attributes</h3> |
|
38 |
34 <table> |
39 <table> |
35 <tr><td>SUPPORTED_TYPES</td></tr><tr><td>_commentsub</td></tr><tr><td>_getnext</td></tr><tr><td>_modules</td></tr><tr><td>_normalize</td></tr> |
40 <tr><td>SUPPORTED_TYPES</td></tr><tr><td>_commentsub</td></tr><tr><td>_getnext</td></tr><tr><td>_modules</td></tr><tr><td>_normalize</td></tr> |
36 </table> |
41 </table> |
37 <h3>Classes</h3> |
42 <h3>Classes</h3> |
38 <table> |
43 |
|
44 <table> |
|
45 |
39 <tr> |
46 <tr> |
40 <td><a href="#Attribute">Attribute</a></td> |
47 <td><a href="#Attribute">Attribute</a></td> |
41 <td>Class to represent a CORBA IDL attribute.</td> |
48 <td>Class to represent a CORBA IDL attribute.</td> |
42 </tr><tr> |
49 </tr> |
|
50 <tr> |
43 <td><a href="#Function">Function</a></td> |
51 <td><a href="#Function">Function</a></td> |
44 <td>Class to represent a CORBA IDL function.</td> |
52 <td>Class to represent a CORBA IDL function.</td> |
45 </tr><tr> |
53 </tr> |
|
54 <tr> |
46 <td><a href="#Interface">Interface</a></td> |
55 <td><a href="#Interface">Interface</a></td> |
47 <td>Class to represent a CORBA IDL interface.</td> |
56 <td>Class to represent a CORBA IDL interface.</td> |
48 </tr><tr> |
57 </tr> |
|
58 <tr> |
49 <td><a href="#Module">Module</a></td> |
59 <td><a href="#Module">Module</a></td> |
50 <td>Class to represent a CORBA IDL module.</td> |
60 <td>Class to represent a CORBA IDL module.</td> |
51 </tr><tr> |
61 </tr> |
|
62 <tr> |
52 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> |
63 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> |
53 <td>Mixin class implementing the notion of visibility.</td> |
64 <td>Mixin class implementing the notion of visibility.</td> |
54 </tr> |
65 </tr> |
55 </table> |
66 </table> |
56 <h3>Functions</h3> |
67 <h3>Functions</h3> |
57 <table> |
68 |
|
69 <table> |
|
70 |
58 <tr> |
71 <tr> |
59 <td><a href="#readmodule_ex">readmodule_ex</a></td> |
72 <td><a href="#readmodule_ex">readmodule_ex</a></td> |
60 <td>Read a CORBA IDL file and return a dictionary of classes, functions and modules.</td> |
73 <td>Read a CORBA IDL file and return a dictionary of classes, functions and modules.</td> |
61 </tr> |
74 </tr> |
62 </table> |
75 </table> |
63 <hr /><hr /> |
76 <hr /> |
|
77 <hr /> |
64 <a NAME="Attribute" ID="Attribute"></a> |
78 <a NAME="Attribute" ID="Attribute"></a> |
65 <h2>Attribute</h2> |
79 <h2>Attribute</h2> |
|
80 |
66 <p> |
81 <p> |
67 Class to represent a CORBA IDL attribute. |
82 Class to represent a CORBA IDL attribute. |
68 </p> |
83 </p> |
69 <h3>Derived from</h3> |
84 <h3>Derived from</h3> |
70 ClbrBaseClasses.Attribute, VisibilityMixin |
85 ClbrBaseClasses.Attribute, VisibilityMixin |
71 <h3>Class Attributes</h3> |
86 <h3>Class Attributes</h3> |
|
87 |
72 <table> |
88 <table> |
73 <tr><td>None</td></tr> |
89 <tr><td>None</td></tr> |
74 </table> |
90 </table> |
75 <h3>Class Methods</h3> |
91 <h3>Class Methods</h3> |
|
92 |
76 <table> |
93 <table> |
77 <tr><td>None</td></tr> |
94 <tr><td>None</td></tr> |
78 </table> |
95 </table> |
79 <h3>Methods</h3> |
96 <h3>Methods</h3> |
80 <table> |
97 |
|
98 <table> |
|
99 |
81 <tr> |
100 <tr> |
82 <td><a href="#Attribute.__init__">Attribute</a></td> |
101 <td><a href="#Attribute.__init__">Attribute</a></td> |
83 <td>Constructor</td> |
102 <td>Constructor</td> |
84 </tr> |
103 </tr> |
85 </table> |
104 </table> |
86 <h3>Static Methods</h3> |
105 <h3>Static Methods</h3> |
87 <table> |
106 |
88 <tr><td>None</td></tr> |
107 <table> |
89 </table> |
108 <tr><td>None</td></tr> |
|
109 </table> |
|
110 |
90 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> |
111 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> |
91 <h4>Attribute (Constructor)</h4> |
112 <h4>Attribute (Constructor)</h4> |
92 <b>Attribute</b>(<i>module, name, file, lineno</i>) |
113 <b>Attribute</b>(<i>module, name, file, lineno</i>) |
|
114 |
93 <p> |
115 <p> |
94 Constructor |
116 Constructor |
95 </p><dl> |
117 </p> |
|
118 <dl> |
|
119 |
96 <dt><i>module</i> (str)</dt> |
120 <dt><i>module</i> (str)</dt> |
97 <dd> |
121 <dd> |
98 name of the module containing this attribute |
122 name of the module containing this attribute |
99 </dd><dt><i>name</i> (str)</dt> |
123 </dd> |
|
124 <dt><i>name</i> (str)</dt> |
100 <dd> |
125 <dd> |
101 name of this attribute |
126 name of this attribute |
102 </dd><dt><i>file</i> (str)</dt> |
127 </dd> |
|
128 <dt><i>file</i> (str)</dt> |
103 <dd> |
129 <dd> |
104 filename containing this attribute |
130 filename containing this attribute |
105 </dd><dt><i>lineno</i> (int)</dt> |
131 </dd> |
|
132 <dt><i>lineno</i> (int)</dt> |
106 <dd> |
133 <dd> |
107 line number of the attribute definition |
134 line number of the attribute definition |
108 </dd> |
135 </dd> |
109 </dl> |
136 </dl> |
110 <div align="right"><a href="#top">Up</a></div> |
137 <div align="right"><a href="#top">Up</a></div> |
111 <hr /><hr /> |
138 <hr /> |
|
139 <hr /> |
112 <a NAME="Function" ID="Function"></a> |
140 <a NAME="Function" ID="Function"></a> |
113 <h2>Function</h2> |
141 <h2>Function</h2> |
|
142 |
114 <p> |
143 <p> |
115 Class to represent a CORBA IDL function. |
144 Class to represent a CORBA IDL function. |
116 </p> |
145 </p> |
117 <h3>Derived from</h3> |
146 <h3>Derived from</h3> |
118 ClbrBaseClasses.Function, VisibilityMixin |
147 ClbrBaseClasses.Function, VisibilityMixin |
119 <h3>Class Attributes</h3> |
148 <h3>Class Attributes</h3> |
|
149 |
120 <table> |
150 <table> |
121 <tr><td>None</td></tr> |
151 <tr><td>None</td></tr> |
122 </table> |
152 </table> |
123 <h3>Class Methods</h3> |
153 <h3>Class Methods</h3> |
|
154 |
124 <table> |
155 <table> |
125 <tr><td>None</td></tr> |
156 <tr><td>None</td></tr> |
126 </table> |
157 </table> |
127 <h3>Methods</h3> |
158 <h3>Methods</h3> |
128 <table> |
159 |
|
160 <table> |
|
161 |
129 <tr> |
162 <tr> |
130 <td><a href="#Function.__init__">Function</a></td> |
163 <td><a href="#Function.__init__">Function</a></td> |
131 <td>Constructor</td> |
164 <td>Constructor</td> |
132 </tr> |
165 </tr> |
133 </table> |
166 </table> |
134 <h3>Static Methods</h3> |
167 <h3>Static Methods</h3> |
135 <table> |
168 |
136 <tr><td>None</td></tr> |
169 <table> |
137 </table> |
170 <tr><td>None</td></tr> |
|
171 </table> |
|
172 |
138 <a NAME="Function.__init__" ID="Function.__init__"></a> |
173 <a NAME="Function.__init__" ID="Function.__init__"></a> |
139 <h4>Function (Constructor)</h4> |
174 <h4>Function (Constructor)</h4> |
140 <b>Function</b>(<i>module, name, file, lineno, signature='', separator=', '</i>) |
175 <b>Function</b>(<i>module, name, file, lineno, signature='', separator=', '</i>) |
|
176 |
141 <p> |
177 <p> |
142 Constructor |
178 Constructor |
143 </p><dl> |
179 </p> |
|
180 <dl> |
|
181 |
144 <dt><i>module</i> (str)</dt> |
182 <dt><i>module</i> (str)</dt> |
145 <dd> |
183 <dd> |
146 name of the module containing this function |
184 name of the module containing this function |
147 </dd><dt><i>name</i> (str)</dt> |
185 </dd> |
|
186 <dt><i>name</i> (str)</dt> |
148 <dd> |
187 <dd> |
149 name of this function |
188 name of this function |
150 </dd><dt><i>file</i> (str)</dt> |
189 </dd> |
|
190 <dt><i>file</i> (str)</dt> |
151 <dd> |
191 <dd> |
152 filename containing this function |
192 filename containing this function |
153 </dd><dt><i>lineno</i> (int)</dt> |
193 </dd> |
|
194 <dt><i>lineno</i> (int)</dt> |
154 <dd> |
195 <dd> |
155 line number of the function definition |
196 line number of the function definition |
156 </dd><dt><i>signature</i> (str)</dt> |
197 </dd> |
|
198 <dt><i>signature</i> (str)</dt> |
157 <dd> |
199 <dd> |
158 parameter list of the function |
200 parameter list of the function |
159 </dd><dt><i>separator</i> (str)</dt> |
201 </dd> |
|
202 <dt><i>separator</i> (str)</dt> |
160 <dd> |
203 <dd> |
161 string separating the parameters |
204 string separating the parameters |
162 </dd> |
205 </dd> |
163 </dl> |
206 </dl> |
164 <div align="right"><a href="#top">Up</a></div> |
207 <div align="right"><a href="#top">Up</a></div> |
165 <hr /><hr /> |
208 <hr /> |
|
209 <hr /> |
166 <a NAME="Interface" ID="Interface"></a> |
210 <a NAME="Interface" ID="Interface"></a> |
167 <h2>Interface</h2> |
211 <h2>Interface</h2> |
|
212 |
168 <p> |
213 <p> |
169 Class to represent a CORBA IDL interface. |
214 Class to represent a CORBA IDL interface. |
170 </p> |
215 </p> |
171 <h3>Derived from</h3> |
216 <h3>Derived from</h3> |
172 ClbrBaseClasses.Class, VisibilityMixin |
217 ClbrBaseClasses.Class, VisibilityMixin |
173 <h3>Class Attributes</h3> |
218 <h3>Class Attributes</h3> |
|
219 |
174 <table> |
220 <table> |
175 <tr><td>None</td></tr> |
221 <tr><td>None</td></tr> |
176 </table> |
222 </table> |
177 <h3>Class Methods</h3> |
223 <h3>Class Methods</h3> |
|
224 |
178 <table> |
225 <table> |
179 <tr><td>None</td></tr> |
226 <tr><td>None</td></tr> |
180 </table> |
227 </table> |
181 <h3>Methods</h3> |
228 <h3>Methods</h3> |
182 <table> |
229 |
|
230 <table> |
|
231 |
183 <tr> |
232 <tr> |
184 <td><a href="#Interface.__init__">Interface</a></td> |
233 <td><a href="#Interface.__init__">Interface</a></td> |
185 <td>Constructor</td> |
234 <td>Constructor</td> |
186 </tr> |
235 </tr> |
187 </table> |
236 </table> |
188 <h3>Static Methods</h3> |
237 <h3>Static Methods</h3> |
189 <table> |
238 |
190 <tr><td>None</td></tr> |
239 <table> |
191 </table> |
240 <tr><td>None</td></tr> |
|
241 </table> |
|
242 |
192 <a NAME="Interface.__init__" ID="Interface.__init__"></a> |
243 <a NAME="Interface.__init__" ID="Interface.__init__"></a> |
193 <h4>Interface (Constructor)</h4> |
244 <h4>Interface (Constructor)</h4> |
194 <b>Interface</b>(<i>module, name, superClasses, file, lineno</i>) |
245 <b>Interface</b>(<i>module, name, superClasses, file, lineno</i>) |
|
246 |
195 <p> |
247 <p> |
196 Constructor |
248 Constructor |
197 </p><dl> |
249 </p> |
|
250 <dl> |
|
251 |
198 <dt><i>module</i> (str)</dt> |
252 <dt><i>module</i> (str)</dt> |
199 <dd> |
253 <dd> |
200 name of the module containing this interface |
254 name of the module containing this interface |
201 </dd><dt><i>name</i> (str)</dt> |
255 </dd> |
|
256 <dt><i>name</i> (str)</dt> |
202 <dd> |
257 <dd> |
203 name of this interface |
258 name of this interface |
204 </dd><dt><i>superClasses</i> (list of str)</dt> |
259 </dd> |
|
260 <dt><i>superClasses</i> (list of str)</dt> |
205 <dd> |
261 <dd> |
206 list of interface names this interface is |
262 list of interface names this interface is |
207 inherited from |
263 inherited from |
208 </dd><dt><i>file</i> (str)</dt> |
264 </dd> |
|
265 <dt><i>file</i> (str)</dt> |
209 <dd> |
266 <dd> |
210 filename containing this interface |
267 filename containing this interface |
211 </dd><dt><i>lineno</i> (int)</dt> |
268 </dd> |
|
269 <dt><i>lineno</i> (int)</dt> |
212 <dd> |
270 <dd> |
213 line number of the interface definition |
271 line number of the interface definition |
214 </dd> |
272 </dd> |
215 </dl> |
273 </dl> |
216 <div align="right"><a href="#top">Up</a></div> |
274 <div align="right"><a href="#top">Up</a></div> |
217 <hr /><hr /> |
275 <hr /> |
|
276 <hr /> |
218 <a NAME="Module" ID="Module"></a> |
277 <a NAME="Module" ID="Module"></a> |
219 <h2>Module</h2> |
278 <h2>Module</h2> |
|
279 |
220 <p> |
280 <p> |
221 Class to represent a CORBA IDL module. |
281 Class to represent a CORBA IDL module. |
222 </p> |
282 </p> |
223 <h3>Derived from</h3> |
283 <h3>Derived from</h3> |
224 ClbrBaseClasses.Module, VisibilityMixin |
284 ClbrBaseClasses.Module, VisibilityMixin |
225 <h3>Class Attributes</h3> |
285 <h3>Class Attributes</h3> |
|
286 |
226 <table> |
287 <table> |
227 <tr><td>None</td></tr> |
288 <tr><td>None</td></tr> |
228 </table> |
289 </table> |
229 <h3>Class Methods</h3> |
290 <h3>Class Methods</h3> |
|
291 |
230 <table> |
292 <table> |
231 <tr><td>None</td></tr> |
293 <tr><td>None</td></tr> |
232 </table> |
294 </table> |
233 <h3>Methods</h3> |
295 <h3>Methods</h3> |
234 <table> |
296 |
|
297 <table> |
|
298 |
235 <tr> |
299 <tr> |
236 <td><a href="#Module.__init__">Module</a></td> |
300 <td><a href="#Module.__init__">Module</a></td> |
237 <td>Constructor</td> |
301 <td>Constructor</td> |
238 </tr> |
302 </tr> |
239 </table> |
303 </table> |
240 <h3>Static Methods</h3> |
304 <h3>Static Methods</h3> |
241 <table> |
305 |
242 <tr><td>None</td></tr> |
306 <table> |
243 </table> |
307 <tr><td>None</td></tr> |
|
308 </table> |
|
309 |
244 <a NAME="Module.__init__" ID="Module.__init__"></a> |
310 <a NAME="Module.__init__" ID="Module.__init__"></a> |
245 <h4>Module (Constructor)</h4> |
311 <h4>Module (Constructor)</h4> |
246 <b>Module</b>(<i>module, name, file, lineno</i>) |
312 <b>Module</b>(<i>module, name, file, lineno</i>) |
|
313 |
247 <p> |
314 <p> |
248 Constructor |
315 Constructor |
249 </p><dl> |
316 </p> |
|
317 <dl> |
|
318 |
250 <dt><i>module</i> (str)</dt> |
319 <dt><i>module</i> (str)</dt> |
251 <dd> |
320 <dd> |
252 name of the module containing this module |
321 name of the module containing this module |
253 </dd><dt><i>name</i> (str)</dt> |
322 </dd> |
|
323 <dt><i>name</i> (str)</dt> |
254 <dd> |
324 <dd> |
255 name of this module |
325 name of this module |
256 </dd><dt><i>file</i> (str)</dt> |
326 </dd> |
|
327 <dt><i>file</i> (str)</dt> |
257 <dd> |
328 <dd> |
258 filename containing this module |
329 filename containing this module |
259 </dd><dt><i>lineno</i> (int)</dt> |
330 </dd> |
|
331 <dt><i>lineno</i> (int)</dt> |
260 <dd> |
332 <dd> |
261 line number of the module definition |
333 line number of the module definition |
262 </dd> |
334 </dd> |
263 </dl> |
335 </dl> |
264 <div align="right"><a href="#top">Up</a></div> |
336 <div align="right"><a href="#top">Up</a></div> |
265 <hr /><hr /> |
337 <hr /> |
|
338 <hr /> |
266 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> |
339 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> |
267 <h2>VisibilityMixin</h2> |
340 <h2>VisibilityMixin</h2> |
|
341 |
268 <p> |
342 <p> |
269 Mixin class implementing the notion of visibility. |
343 Mixin class implementing the notion of visibility. |
270 </p> |
344 </p> |
271 <h3>Derived from</h3> |
345 <h3>Derived from</h3> |
272 ClbrBaseClasses.ClbrVisibilityMixinBase |
346 ClbrBaseClasses.ClbrVisibilityMixinBase |
273 <h3>Class Attributes</h3> |
347 <h3>Class Attributes</h3> |
|
348 |
274 <table> |
349 <table> |
275 <tr><td>None</td></tr> |
350 <tr><td>None</td></tr> |
276 </table> |
351 </table> |
277 <h3>Class Methods</h3> |
352 <h3>Class Methods</h3> |
|
353 |
278 <table> |
354 <table> |
279 <tr><td>None</td></tr> |
355 <tr><td>None</td></tr> |
280 </table> |
356 </table> |
281 <h3>Methods</h3> |
357 <h3>Methods</h3> |
282 <table> |
358 |
|
359 <table> |
|
360 |
283 <tr> |
361 <tr> |
284 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> |
362 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> |
285 <td>Constructor</td> |
363 <td>Constructor</td> |
286 </tr> |
364 </tr> |
287 </table> |
365 </table> |
288 <h3>Static Methods</h3> |
366 <h3>Static Methods</h3> |
289 <table> |
367 |
290 <tr><td>None</td></tr> |
368 <table> |
291 </table> |
369 <tr><td>None</td></tr> |
|
370 </table> |
|
371 |
292 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> |
372 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> |
293 <h4>VisibilityMixin (Constructor)</h4> |
373 <h4>VisibilityMixin (Constructor)</h4> |
294 <b>VisibilityMixin</b>(<i></i>) |
374 <b>VisibilityMixin</b>(<i></i>) |
|
375 |
295 <p> |
376 <p> |
296 Constructor |
377 Constructor |
297 </p> |
378 </p> |
298 <div align="right"><a href="#top">Up</a></div> |
379 <div align="right"><a href="#top">Up</a></div> |
299 <hr /><hr /> |
380 <hr /> |
|
381 <hr /> |
300 <a NAME="readmodule_ex" ID="readmodule_ex"></a> |
382 <a NAME="readmodule_ex" ID="readmodule_ex"></a> |
301 <h2>readmodule_ex</h2> |
383 <h2>readmodule_ex</h2> |
302 <b>readmodule_ex</b>(<i>module, path=None</i>) |
384 <b>readmodule_ex</b>(<i>module, path=None</i>) |
|
385 |
303 <p> |
386 <p> |
304 Read a CORBA IDL file and return a dictionary of classes, functions and |
387 Read a CORBA IDL file and return a dictionary of classes, functions and |
305 modules. |
388 modules. |
306 </p><dl> |
389 </p> |
|
390 <dl> |
|
391 |
307 <dt><i>module</i> (str)</dt> |
392 <dt><i>module</i> (str)</dt> |
308 <dd> |
393 <dd> |
309 name of the CORBA IDL file |
394 name of the CORBA IDL file |
310 </dd><dt><i>path</i> (list of str)</dt> |
395 </dd> |
|
396 <dt><i>path</i> (list of str)</dt> |
311 <dd> |
397 <dd> |
312 path the file should be searched in |
398 path the file should be searched in |
313 </dd> |
399 </dd> |
314 </dl><dl> |
400 </dl> |
|
401 <dl> |
315 <dt>Returns:</dt> |
402 <dt>Returns:</dt> |
316 <dd> |
403 <dd> |
317 the resulting dictionary |
404 the resulting dictionary |
318 </dd> |
405 </dd> |
319 </dl><dl> |
406 </dl> |
|
407 <dl> |
320 <dt>Return Type:</dt> |
408 <dt>Return Type:</dt> |
321 <dd> |
409 <dd> |
322 dict |
410 dict |
323 </dd> |
411 </dd> |
324 </dl> |
412 </dl> |