Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.idlclbr.html
src/eric7/Documentation/Source/eric7.Utilities.ClassBrowsers.idlclbr.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 9236
- db53a9efe7ef
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Utilities.ClassBrowsers.idlclbr</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.Utilities.ClassBrowsers.idlclbr</h1> | |
| 10 | |
| 11 <p> | |
| 12 Parse a CORBA IDL file and retrieve modules, interfaces, methods and | |
| 13 attributes. | |
| 14 </p> | |
| 15 <p> | |
| 16 Parse enough of a CORBA IDL file to recognize module, interface and method | |
| 17 definitions and to find out the superclasses of an interface as well as its | |
| 18 attributes. | |
| 19 </p> | |
| 20 <p> | |
| 21 It is based on the Python class browser found in this package. | |
| 22 </p> | |
| 23 <h3>Global Attributes</h3> | |
| 24 | |
| 25 <table> | |
| 26 <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> | |
| 27 </table> | |
| 28 <h3>Classes</h3> | |
| 29 | |
| 30 <table> | |
| 31 | |
| 32 <tr> | |
| 33 <td><a href="#Attribute">Attribute</a></td> | |
| 34 <td>Class to represent a CORBA IDL attribute.</td> | |
| 35 </tr> | |
| 36 <tr> | |
| 37 <td><a href="#Function">Function</a></td> | |
| 38 <td>Class to represent a CORBA IDL function.</td> | |
| 39 </tr> | |
| 40 <tr> | |
| 41 <td><a href="#Interface">Interface</a></td> | |
| 42 <td>Class to represent a CORBA IDL interface.</td> | |
| 43 </tr> | |
| 44 <tr> | |
| 45 <td><a href="#Module">Module</a></td> | |
| 46 <td>Class to represent a CORBA IDL module.</td> | |
| 47 </tr> | |
| 48 <tr> | |
| 49 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> | |
| 50 <td>Mixin class implementing the notion of visibility.</td> | |
| 51 </tr> | |
| 52 </table> | |
| 53 <h3>Functions</h3> | |
| 54 | |
| 55 <table> | |
| 56 | |
| 57 <tr> | |
| 58 <td><a href="#calculateEndline">calculateEndline</a></td> | |
| 59 <td>Function to calculate the end line.</td> | |
| 60 </tr> | |
| 61 <tr> | |
| 62 <td><a href="#calculateMethodEndline">calculateMethodEndline</a></td> | |
| 63 <td>Function to calculate the end line.</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#readmodule_ex">readmodule_ex</a></td> | |
| 67 <td>Read a CORBA IDL file and return a dictionary of classes, functions and modules.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#scan">scan</a></td> | |
| 71 <td>Public method to scan the given source text.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <hr /> | |
| 75 <hr /> | |
| 76 <a NAME="Attribute" ID="Attribute"></a> | |
| 77 <h2>Attribute</h2> | |
| 78 | |
| 79 <p> | |
| 80 Class to represent a CORBA IDL attribute. | |
| 81 </p> | |
| 82 <h3>Derived from</h3> | |
| 83 ClbrBaseClasses.Attribute, VisibilityMixin | |
| 84 <h3>Class Attributes</h3> | |
| 85 | |
| 86 <table> | |
| 87 <tr><td>None</td></tr> | |
| 88 </table> | |
| 89 <h3>Class Methods</h3> | |
| 90 | |
| 91 <table> | |
| 92 <tr><td>None</td></tr> | |
| 93 </table> | |
| 94 <h3>Methods</h3> | |
| 95 | |
| 96 <table> | |
| 97 | |
| 98 <tr> | |
| 99 <td><a href="#Attribute.__init__">Attribute</a></td> | |
| 100 <td>Constructor</td> | |
| 101 </tr> | |
| 102 </table> | |
| 103 <h3>Static Methods</h3> | |
| 104 | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 | |
| 109 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> | |
| 110 <h4>Attribute (Constructor)</h4> | |
| 111 <b>Attribute</b>(<i>module, name, file, lineno</i>) | |
| 112 | |
| 113 <p> | |
| 114 Constructor | |
| 115 </p> | |
| 116 <dl> | |
| 117 | |
| 118 <dt><i>module</i> (str)</dt> | |
| 119 <dd> | |
| 120 name of the module containing this attribute | |
| 121 </dd> | |
| 122 <dt><i>name</i> (str)</dt> | |
| 123 <dd> | |
| 124 name of this attribute | |
| 125 </dd> | |
| 126 <dt><i>file</i> (str)</dt> | |
| 127 <dd> | |
| 128 filename containing this attribute | |
| 129 </dd> | |
| 130 <dt><i>lineno</i> (int)</dt> | |
| 131 <dd> | |
| 132 line number of the attribute definition | |
| 133 </dd> | |
| 134 </dl> | |
| 135 <div align="right"><a href="#top">Up</a></div> | |
| 136 <hr /> | |
| 137 <hr /> | |
| 138 <a NAME="Function" ID="Function"></a> | |
| 139 <h2>Function</h2> | |
| 140 | |
| 141 <p> | |
| 142 Class to represent a CORBA IDL function. | |
| 143 </p> | |
| 144 <h3>Derived from</h3> | |
| 145 ClbrBaseClasses.Function, VisibilityMixin | |
| 146 <h3>Class Attributes</h3> | |
| 147 | |
| 148 <table> | |
| 149 <tr><td>None</td></tr> | |
| 150 </table> | |
| 151 <h3>Class Methods</h3> | |
| 152 | |
| 153 <table> | |
| 154 <tr><td>None</td></tr> | |
| 155 </table> | |
| 156 <h3>Methods</h3> | |
| 157 | |
| 158 <table> | |
| 159 | |
| 160 <tr> | |
| 161 <td><a href="#Function.__init__">Function</a></td> | |
| 162 <td>Constructor</td> | |
| 163 </tr> | |
| 164 </table> | |
| 165 <h3>Static Methods</h3> | |
| 166 | |
| 167 <table> | |
| 168 <tr><td>None</td></tr> | |
| 169 </table> | |
| 170 | |
| 171 <a NAME="Function.__init__" ID="Function.__init__"></a> | |
| 172 <h4>Function (Constructor)</h4> | |
| 173 <b>Function</b>(<i>module, name, file, lineno, signature='', separator=', '</i>) | |
| 174 | |
| 175 <p> | |
| 176 Constructor | |
| 177 </p> | |
| 178 <dl> | |
| 179 | |
| 180 <dt><i>module</i> (str)</dt> | |
| 181 <dd> | |
| 182 name of the module containing this function | |
| 183 </dd> | |
| 184 <dt><i>name</i> (str)</dt> | |
| 185 <dd> | |
| 186 name of this function | |
| 187 </dd> | |
| 188 <dt><i>file</i> (str)</dt> | |
| 189 <dd> | |
| 190 filename containing this function | |
| 191 </dd> | |
| 192 <dt><i>lineno</i> (int)</dt> | |
| 193 <dd> | |
| 194 line number of the function definition | |
| 195 </dd> | |
| 196 <dt><i>signature</i> (str)</dt> | |
| 197 <dd> | |
| 198 parameter list of the function | |
| 199 </dd> | |
| 200 <dt><i>separator</i> (str)</dt> | |
| 201 <dd> | |
| 202 string separating the parameters | |
| 203 </dd> | |
| 204 </dl> | |
| 205 <div align="right"><a href="#top">Up</a></div> | |
| 206 <hr /> | |
| 207 <hr /> | |
| 208 <a NAME="Interface" ID="Interface"></a> | |
| 209 <h2>Interface</h2> | |
| 210 | |
| 211 <p> | |
| 212 Class to represent a CORBA IDL interface. | |
| 213 </p> | |
| 214 <h3>Derived from</h3> | |
| 215 ClbrBaseClasses.Class, VisibilityMixin | |
| 216 <h3>Class Attributes</h3> | |
| 217 | |
| 218 <table> | |
| 219 <tr><td>None</td></tr> | |
| 220 </table> | |
| 221 <h3>Class Methods</h3> | |
| 222 | |
| 223 <table> | |
| 224 <tr><td>None</td></tr> | |
| 225 </table> | |
| 226 <h3>Methods</h3> | |
| 227 | |
| 228 <table> | |
| 229 | |
| 230 <tr> | |
| 231 <td><a href="#Interface.__init__">Interface</a></td> | |
| 232 <td>Constructor</td> | |
| 233 </tr> | |
| 234 </table> | |
| 235 <h3>Static Methods</h3> | |
| 236 | |
| 237 <table> | |
| 238 <tr><td>None</td></tr> | |
| 239 </table> | |
| 240 | |
| 241 <a NAME="Interface.__init__" ID="Interface.__init__"></a> | |
| 242 <h4>Interface (Constructor)</h4> | |
| 243 <b>Interface</b>(<i>module, name, superClasses, file, lineno</i>) | |
| 244 | |
| 245 <p> | |
| 246 Constructor | |
| 247 </p> | |
| 248 <dl> | |
| 249 | |
| 250 <dt><i>module</i> (str)</dt> | |
| 251 <dd> | |
| 252 name of the module containing this interface | |
| 253 </dd> | |
| 254 <dt><i>name</i> (str)</dt> | |
| 255 <dd> | |
| 256 name of this interface | |
| 257 </dd> | |
| 258 <dt><i>superClasses</i> (list of str)</dt> | |
| 259 <dd> | |
| 260 list of interface names this interface is | |
| 261 inherited from | |
| 262 </dd> | |
| 263 <dt><i>file</i> (str)</dt> | |
| 264 <dd> | |
| 265 filename containing this interface | |
| 266 </dd> | |
| 267 <dt><i>lineno</i> (int)</dt> | |
| 268 <dd> | |
| 269 line number of the interface definition | |
| 270 </dd> | |
| 271 </dl> | |
| 272 <div align="right"><a href="#top">Up</a></div> | |
| 273 <hr /> | |
| 274 <hr /> | |
| 275 <a NAME="Module" ID="Module"></a> | |
| 276 <h2>Module</h2> | |
| 277 | |
| 278 <p> | |
| 279 Class to represent a CORBA IDL module. | |
| 280 </p> | |
| 281 <h3>Derived from</h3> | |
| 282 ClbrBaseClasses.Module, VisibilityMixin | |
| 283 <h3>Class Attributes</h3> | |
| 284 | |
| 285 <table> | |
| 286 <tr><td>None</td></tr> | |
| 287 </table> | |
| 288 <h3>Class Methods</h3> | |
| 289 | |
| 290 <table> | |
| 291 <tr><td>None</td></tr> | |
| 292 </table> | |
| 293 <h3>Methods</h3> | |
| 294 | |
| 295 <table> | |
| 296 | |
| 297 <tr> | |
| 298 <td><a href="#Module.__init__">Module</a></td> | |
| 299 <td>Constructor</td> | |
| 300 </tr> | |
| 301 </table> | |
| 302 <h3>Static Methods</h3> | |
| 303 | |
| 304 <table> | |
| 305 <tr><td>None</td></tr> | |
| 306 </table> | |
| 307 | |
| 308 <a NAME="Module.__init__" ID="Module.__init__"></a> | |
| 309 <h4>Module (Constructor)</h4> | |
| 310 <b>Module</b>(<i>module, name, file, lineno</i>) | |
| 311 | |
| 312 <p> | |
| 313 Constructor | |
| 314 </p> | |
| 315 <dl> | |
| 316 | |
| 317 <dt><i>module</i> (str)</dt> | |
| 318 <dd> | |
| 319 name of the module containing this module | |
| 320 </dd> | |
| 321 <dt><i>name</i> (str)</dt> | |
| 322 <dd> | |
| 323 name of this module | |
| 324 </dd> | |
| 325 <dt><i>file</i> (str)</dt> | |
| 326 <dd> | |
| 327 filename containing this module | |
| 328 </dd> | |
| 329 <dt><i>lineno</i> (int)</dt> | |
| 330 <dd> | |
| 331 line number of the module definition | |
| 332 </dd> | |
| 333 </dl> | |
| 334 <div align="right"><a href="#top">Up</a></div> | |
| 335 <hr /> | |
| 336 <hr /> | |
| 337 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> | |
| 338 <h2>VisibilityMixin</h2> | |
| 339 | |
| 340 <p> | |
| 341 Mixin class implementing the notion of visibility. | |
| 342 </p> | |
| 343 <h3>Derived from</h3> | |
| 344 ClbrBaseClasses.ClbrVisibilityMixinBase | |
| 345 <h3>Class Attributes</h3> | |
| 346 | |
| 347 <table> | |
| 348 <tr><td>None</td></tr> | |
| 349 </table> | |
| 350 <h3>Class Methods</h3> | |
| 351 | |
| 352 <table> | |
| 353 <tr><td>None</td></tr> | |
| 354 </table> | |
| 355 <h3>Methods</h3> | |
| 356 | |
| 357 <table> | |
| 358 | |
| 359 <tr> | |
| 360 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> | |
| 361 <td>Constructor</td> | |
| 362 </tr> | |
| 363 </table> | |
| 364 <h3>Static Methods</h3> | |
| 365 | |
| 366 <table> | |
| 367 <tr><td>None</td></tr> | |
| 368 </table> | |
| 369 | |
| 370 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> | |
| 371 <h4>VisibilityMixin (Constructor)</h4> | |
| 372 <b>VisibilityMixin</b>(<i></i>) | |
| 373 | |
| 374 <p> | |
| 375 Constructor | |
| 376 </p> | |
| 377 <div align="right"><a href="#top">Up</a></div> | |
| 378 <hr /> | |
| 379 <hr /> | |
| 380 <a NAME="calculateEndline" ID="calculateEndline"></a> | |
| 381 <h2>calculateEndline</h2> | |
| 382 <b>calculateEndline</b>(<i>lineno, lines</i>) | |
| 383 | |
| 384 <p> | |
| 385 Function to calculate the end line. | |
| 386 </p> | |
| 387 <dl> | |
| 388 | |
| 389 <dt><i>lineno</i> (int)</dt> | |
| 390 <dd> | |
| 391 line number to start at (one based) | |
| 392 </dd> | |
| 393 <dt><i>lines</i> (list of str)</dt> | |
| 394 <dd> | |
| 395 list of source lines | |
| 396 </dd> | |
| 397 </dl> | |
| 398 <dl> | |
| 399 <dt>Return:</dt> | |
| 400 <dd> | |
| 401 end line (one based) | |
| 402 </dd> | |
| 403 </dl> | |
| 404 <dl> | |
| 405 <dt>Return Type:</dt> | |
| 406 <dd> | |
| 407 int | |
| 408 </dd> | |
| 409 </dl> | |
| 410 <div align="right"><a href="#top">Up</a></div> | |
| 411 <hr /> | |
| 412 <hr /> | |
| 413 <a NAME="calculateMethodEndline" ID="calculateMethodEndline"></a> | |
| 414 <h2>calculateMethodEndline</h2> | |
| 415 <b>calculateMethodEndline</b>(<i>lineno, lines</i>) | |
| 416 | |
| 417 <p> | |
| 418 Function to calculate the end line. | |
| 419 </p> | |
| 420 <dl> | |
| 421 | |
| 422 <dt><i>lineno</i> (int)</dt> | |
| 423 <dd> | |
| 424 line number to start at (one based) | |
| 425 </dd> | |
| 426 <dt><i>lines</i> (list of str)</dt> | |
| 427 <dd> | |
| 428 list of source lines | |
| 429 </dd> | |
| 430 </dl> | |
| 431 <dl> | |
| 432 <dt>Return:</dt> | |
| 433 <dd> | |
| 434 end line (one based) | |
| 435 </dd> | |
| 436 </dl> | |
| 437 <dl> | |
| 438 <dt>Return Type:</dt> | |
| 439 <dd> | |
| 440 int | |
| 441 </dd> | |
| 442 </dl> | |
| 443 <div align="right"><a href="#top">Up</a></div> | |
| 444 <hr /> | |
| 445 <hr /> | |
| 446 <a NAME="readmodule_ex" ID="readmodule_ex"></a> | |
| 447 <h2>readmodule_ex</h2> | |
| 448 <b>readmodule_ex</b>(<i>module, path=None</i>) | |
| 449 | |
| 450 <p> | |
| 451 Read a CORBA IDL file and return a dictionary of classes, functions and | |
| 452 modules. | |
| 453 </p> | |
| 454 <dl> | |
| 455 | |
| 456 <dt><i>module</i> (str)</dt> | |
| 457 <dd> | |
| 458 name of the CORBA IDL file | |
| 459 </dd> | |
| 460 <dt><i>path</i> (list of str)</dt> | |
| 461 <dd> | |
| 462 path the file should be searched in | |
| 463 </dd> | |
| 464 </dl> | |
| 465 <dl> | |
| 466 <dt>Return:</dt> | |
| 467 <dd> | |
| 468 the resulting dictionary | |
| 469 </dd> | |
| 470 </dl> | |
| 471 <dl> | |
| 472 <dt>Return Type:</dt> | |
| 473 <dd> | |
| 474 dict | |
| 475 </dd> | |
| 476 </dl> | |
| 477 <div align="right"><a href="#top">Up</a></div> | |
| 478 <hr /> | |
| 479 <hr /> | |
| 480 <a NAME="scan" ID="scan"></a> | |
| 481 <h2>scan</h2> | |
| 482 <b>scan</b>(<i>src, file, module</i>) | |
| 483 | |
| 484 <p> | |
| 485 Public method to scan the given source text. | |
| 486 </p> | |
| 487 <dl> | |
| 488 | |
| 489 <dt><i>src</i> (str)</dt> | |
| 490 <dd> | |
| 491 source text to be scanned | |
| 492 </dd> | |
| 493 <dt><i>file</i> (str)</dt> | |
| 494 <dd> | |
| 495 file name associated with the source text | |
| 496 </dd> | |
| 497 <dt><i>module</i> (str)</dt> | |
| 498 <dd> | |
| 499 module name associated with the source text | |
| 500 </dd> | |
| 501 </dl> | |
| 502 <dl> | |
| 503 <dt>Return:</dt> | |
| 504 <dd> | |
| 505 dictionary containing the extracted data | |
| 506 </dd> | |
| 507 </dl> | |
| 508 <dl> | |
| 509 <dt>Return Type:</dt> | |
| 510 <dd> | |
| 511 dict | |
| 512 </dd> | |
| 513 </dl> | |
| 514 <div align="right"><a href="#top">Up</a></div> | |
| 515 <hr /> | |
| 516 </body></html> |
