Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html

src/eric7/Documentation/Source/eric7.Utilities.ModuleParser.html

branch
eric7
changeset 10433
328f3ec4b77a
parent 10064
8c3207703dac
child 10479
856476537696
equal deleted inserted replaced
10432:2fe91fe443dd 10433:328f3ec4b77a
128 <p> 128 <p>
129 Constructor 129 Constructor
130 </p> 130 </p>
131 <dl> 131 <dl>
132 132
133 <dt><i>module</i></dt> 133 <dt><i>module</i> (str)</dt>
134 <dd> 134 <dd>
135 name of module containing this function (string) 135 name of module containing this function
136 </dd> 136 </dd>
137 <dt><i>name</i></dt> 137 <dt><i>name</i> (str)</dt>
138 <dd> 138 <dd>
139 name of the function (string) 139 name of the function
140 </dd> 140 </dd>
141 <dt><i>file</i></dt> 141 <dt><i>file</i> (str)</dt>
142 <dd> 142 <dd>
143 name of file containing this function (string) 143 name of file containing this function
144 </dd> 144 </dd>
145 <dt><i>lineno</i></dt> 145 <dt><i>lineno</i> (int)</dt>
146 <dd> 146 <dd>
147 linenumber of the first attribute assignment (integer) 147 linenumber of the first attribute assignment
148 </dd> 148 </dd>
149 <dt><i>isSignal</i></dt> 149 <dt><i>isSignal</i> (bool)</dt>
150 <dd> 150 <dd>
151 flag indicating a signal definition (boolean) 151 flag indicating a signal definition
152 </dd> 152 </dd>
153 </dl> 153 </dl>
154 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a> 154 <a NAME="Attribute.addAssignment" ID="Attribute.addAssignment"></a>
155 <h4>Attribute.addAssignment</h4> 155 <h4>Attribute.addAssignment</h4>
156 <b>addAssignment</b>(<i>lineno</i>) 156 <b>addAssignment</b>(<i>lineno</i>)
158 <p> 158 <p>
159 Public method to add another assignment line number. 159 Public method to add another assignment line number.
160 </p> 160 </p>
161 <dl> 161 <dl>
162 162
163 <dt><i>lineno</i></dt> 163 <dt><i>lineno</i> (int)</dt>
164 <dd> 164 <dd>
165 linenumber of the additional attribute assignment 165 linenumber of the additional attribute assignment
166 (integer)
167 </dd> 166 </dd>
168 </dl> 167 </dl>
169 <div align="right"><a href="#top">Up</a></div> 168 <div align="right"><a href="#top">Up</a></div>
170 <hr /> 169 <hr />
171 <hr /> 170 <hr />
237 <p> 236 <p>
238 Constructor 237 Constructor
239 </p> 238 </p>
240 <dl> 239 <dl>
241 240
242 <dt><i>module</i></dt> 241 <dt><i>module</i> (str)</dt>
243 <dd> 242 <dd>
244 name of module containing this class (string) 243 name of module containing this class
245 </dd> 244 </dd>
246 <dt><i>name</i></dt> 245 <dt><i>name</i> (str)</dt>
247 <dd> 246 <dd>
248 name of the class (string) 247 name of the class
249 </dd> 248 </dd>
250 <dt><i>superClasses</i></dt> 249 <dt><i>superClasses</i> (list of str)</dt>
251 <dd> 250 <dd>
252 list of classnames this class is inherited from 251 list of classnames this class is inherited from
253 (list of strings) 252 </dd>
254 </dd> 253 <dt><i>file</i> (str)</dt>
255 <dt><i>file</i></dt> 254 <dd>
256 <dd> 255 name of file containing this class
257 name of file containing this class (string) 256 </dd>
258 </dd> 257 <dt><i>lineno</i> (int)</dt>
259 <dt><i>lineno</i></dt> 258 <dd>
260 <dd> 259 linenumber of the class definition
261 linenumber of the class definition (integer)
262 </dd> 260 </dd>
263 </dl> 261 </dl>
264 <a NAME="Class.addAttribute" ID="Class.addAttribute"></a> 262 <a NAME="Class.addAttribute" ID="Class.addAttribute"></a>
265 <h4>Class.addAttribute</h4> 263 <h4>Class.addAttribute</h4>
266 <b>addAttribute</b>(<i>name, attr</i>) 264 <b>addAttribute</b>(<i>name, attr</i>)
268 <p> 266 <p>
269 Public method to add information about attributes. 267 Public method to add information about attributes.
270 </p> 268 </p>
271 <dl> 269 <dl>
272 270
273 <dt><i>name</i></dt> 271 <dt><i>name</i> (str)</dt>
274 <dd> 272 <dd>
275 name of the attribute to add (string) 273 name of the attribute to add
276 </dd> 274 </dd>
277 <dt><i>attr</i></dt> 275 <dt><i>attr</i> (Attribute)</dt>
278 <dd> 276 <dd>
279 Attribute object to be added 277 Attribute object to be added
280 </dd> 278 </dd>
281 </dl> 279 </dl>
282 <a NAME="Class.addDescription" ID="Class.addDescription"></a> 280 <a NAME="Class.addDescription" ID="Class.addDescription"></a>
286 <p> 284 <p>
287 Public method to store the class docstring. 285 Public method to store the class docstring.
288 </p> 286 </p>
289 <dl> 287 <dl>
290 288
291 <dt><i>description</i></dt> 289 <dt><i>description</i> (str)</dt>
292 <dd> 290 <dd>
293 the docstring to be stored (string) 291 the docstring to be stored
294 </dd> 292 </dd>
295 </dl> 293 </dl>
296 <a NAME="Class.addGlobal" ID="Class.addGlobal"></a> 294 <a NAME="Class.addGlobal" ID="Class.addGlobal"></a>
297 <h4>Class.addGlobal</h4> 295 <h4>Class.addGlobal</h4>
298 <b>addGlobal</b>(<i>name, attr</i>) 296 <b>addGlobal</b>(<i>name, attr</i>)
300 <p> 298 <p>
301 Public method to add information about global (class) variables. 299 Public method to add information about global (class) variables.
302 </p> 300 </p>
303 <dl> 301 <dl>
304 302
305 <dt><i>name</i></dt> 303 <dt><i>name</i> (str)</dt>
306 <dd> 304 <dd>
307 name of the global to add (string) 305 name of the global to add
308 </dd> 306 </dd>
309 <dt><i>attr</i></dt> 307 <dt><i>attr</i> (Attribute)</dt>
310 <dd> 308 <dd>
311 Attribute object to be added 309 Attribute object to be added
312 </dd> 310 </dd>
313 </dl> 311 </dl>
314 <a NAME="Class.addMethod" ID="Class.addMethod"></a> 312 <a NAME="Class.addMethod" ID="Class.addMethod"></a>
318 <p> 316 <p>
319 Public method to add information about a method. 317 Public method to add information about a method.
320 </p> 318 </p>
321 <dl> 319 <dl>
322 320
323 <dt><i>name</i></dt> 321 <dt><i>name</i> (str)</dt>
324 <dd> 322 <dd>
325 name of method to be added (string) 323 name of method to be added
326 </dd> 324 </dd>
327 <dt><i>function</i></dt> 325 <dt><i>function</i> (Function)</dt>
328 <dd> 326 <dd>
329 Function object to be added 327 Function object to be added
330 </dd> 328 </dd>
331 </dl> 329 </dl>
332 <a NAME="Class.getAttribute" ID="Class.getAttribute"></a> 330 <a NAME="Class.getAttribute" ID="Class.getAttribute"></a>
336 <p> 334 <p>
337 Public method to retrieve an attribute by name. 335 Public method to retrieve an attribute by name.
338 </p> 336 </p>
339 <dl> 337 <dl>
340 338
341 <dt><i>name</i></dt> 339 <dt><i>name</i> (str)</dt>
342 <dd> 340 <dd>
343 name of the attribute (string) 341 name of the attribute
344 </dd> 342 </dd>
345 </dl> 343 </dl>
346 <dl> 344 <dl>
347 <dt>Return:</dt> 345 <dt>Return:</dt>
348 <dd> 346 <dd>
349 the named attribute or None 347 the named attribute or None
348 </dd>
349 </dl>
350 <dl>
351 <dt>Return Type:</dt>
352 <dd>
353 Attribute
350 </dd> 354 </dd>
351 </dl> 355 </dl>
352 <a NAME="Class.getMethod" ID="Class.getMethod"></a> 356 <a NAME="Class.getMethod" ID="Class.getMethod"></a>
353 <h4>Class.getMethod</h4> 357 <h4>Class.getMethod</h4>
354 <b>getMethod</b>(<i>name</i>) 358 <b>getMethod</b>(<i>name</i>)
356 <p> 360 <p>
357 Public method to retrieve a method by name. 361 Public method to retrieve a method by name.
358 </p> 362 </p>
359 <dl> 363 <dl>
360 364
361 <dt><i>name</i></dt> 365 <dt><i>name</i> (str)</dt>
362 <dd> 366 <dd>
363 name of the method (string) 367 name of the method
364 </dd> 368 </dd>
365 </dl> 369 </dl>
366 <dl> 370 <dl>
367 <dt>Return:</dt> 371 <dt>Return:</dt>
368 <dd> 372 <dd>
369 the named method or None 373 the named method or None
374 </dd>
375 </dl>
376 <dl>
377 <dt>Return Type:</dt>
378 <dd>
379 Function
370 </dd> 380 </dd>
371 </dl> 381 </dl>
372 <a NAME="Class.setEndLine" ID="Class.setEndLine"></a> 382 <a NAME="Class.setEndLine" ID="Class.setEndLine"></a>
373 <h4>Class.setEndLine</h4> 383 <h4>Class.setEndLine</h4>
374 <b>setEndLine</b>(<i>endLineNo</i>) 384 <b>setEndLine</b>(<i>endLineNo</i>)
376 <p> 386 <p>
377 Public method to record the number of the last line of a class. 387 Public method to record the number of the last line of a class.
378 </p> 388 </p>
379 <dl> 389 <dl>
380 390
381 <dt><i>endLineNo</i></dt> 391 <dt><i>endLineNo</i> (int)</dt>
382 <dd> 392 <dd>
383 number of the last line (integer) 393 number of the last line
384 </dd> 394 </dd>
385 </dl> 395 </dl>
386 <div align="right"><a href="#top">Up</a></div> 396 <div align="right"><a href="#top">Up</a></div>
387 <hr /> 397 <hr />
388 <hr /> 398 <hr />
434 <p> 444 <p>
435 Constructor 445 Constructor
436 </p> 446 </p>
437 <dl> 447 <dl>
438 448
439 <dt><i>module</i></dt> 449 <dt><i>module</i> (str)</dt>
440 <dd> 450 <dd>
441 name of module containing this function (string) 451 name of module containing this function
442 </dd> 452 </dd>
443 <dt><i>name</i></dt> 453 <dt><i>name</i> (str)</dt>
444 <dd> 454 <dd>
445 name of the function (string) 455 name of the function
446 </dd> 456 </dd>
447 <dt><i>file</i></dt> 457 <dt><i>file</i> (str)</dt>
448 <dd> 458 <dd>
449 name of file containing this function (string) 459 name of file containing this function
450 </dd> 460 </dd>
451 <dt><i>lineno</i></dt> 461 <dt><i>lineno</i> (int)</dt>
452 <dd> 462 <dd>
453 linenumber of the function definition (integer) 463 linenumber of the function definition
454 </dd> 464 </dd>
455 <dt><i>signature</i></dt> 465 <dt><i>signature</i> (str)</dt>
456 <dd> 466 <dd>
457 the functions call signature (string) 467 the functions call signature
458 </dd> 468 </dd>
459 <dt><i>pyqtSignature</i></dt> 469 <dt><i>pyqtSignature</i> (str)</dt>
460 <dd> 470 <dd>
461 the functions PyQt signature (string) 471 the functions PyQt signature
462 </dd> 472 </dd>
463 <dt><i>modifierType</i></dt> 473 <dt><i>modifierType</i> (int)</dt>
464 <dd> 474 <dd>
465 type of the function 475 type of the function
466 </dd> 476 </dd>
467 <dt><i>annotation</i></dt> 477 <dt><i>annotation</i> (str)</dt>
468 <dd> 478 <dd>
469 return annotation 479 return annotation
470 </dd> 480 </dd>
471 </dl> 481 </dl>
472 <a NAME="Function.addDescription" ID="Function.addDescription"></a> 482 <a NAME="Function.addDescription" ID="Function.addDescription"></a>
476 <p> 486 <p>
477 Public method to store the functions docstring. 487 Public method to store the functions docstring.
478 </p> 488 </p>
479 <dl> 489 <dl>
480 490
481 <dt><i>description</i></dt> 491 <dt><i>description</i> (str)</dt>
482 <dd> 492 <dd>
483 the docstring to be stored (string) 493 the docstring to be stored
484 </dd> 494 </dd>
485 </dl> 495 </dl>
486 <a NAME="Function.setEndLine" ID="Function.setEndLine"></a> 496 <a NAME="Function.setEndLine" ID="Function.setEndLine"></a>
487 <h4>Function.setEndLine</h4> 497 <h4>Function.setEndLine</h4>
488 <b>setEndLine</b>(<i>endLineNo</i>) 498 <b>setEndLine</b>(<i>endLineNo</i>)
490 <p> 500 <p>
491 Public method to record the number of the last line of a class. 501 Public method to record the number of the last line of a class.
492 </p> 502 </p>
493 <dl> 503 <dl>
494 504
495 <dt><i>endLineNo</i></dt> 505 <dt><i>endLineNo</i> (int)</dt>
496 <dd> 506 <dd>
497 number of the last line (integer) 507 number of the last line
498 </dd> 508 </dd>
499 </dl> 509 </dl>
500 <div align="right"><a href="#top">Up</a></div> 510 <div align="right"><a href="#top">Up</a></div>
501 <hr /> 511 <hr />
502 <hr /> 512 <hr />
604 <p> 614 <p>
605 Constructor 615 Constructor
606 </p> 616 </p>
607 <dl> 617 <dl>
608 618
609 <dt><i>name</i></dt> 619 <dt><i>name</i> (str)</dt>
610 <dd> 620 <dd>
611 name of this module (string) 621 name of this module
612 </dd> 622 </dd>
613 <dt><i>file</i></dt> 623 <dt><i>file</i> (str)</dt>
614 <dd> 624 <dd>
615 filename of file containing this module (string) 625 filename of file containing this module
616 </dd> 626 </dd>
617 <dt><i>moduleType</i></dt> 627 <dt><i>moduleType</i> (int)</dt>
618 <dd> 628 <dd>
619 type of this module 629 type of this module
620 </dd> 630 </dd>
621 </dl> 631 </dl>
622 <a NAME="Module.__py_scan" ID="Module.__py_scan"></a> 632 <a NAME="Module.__py_scan" ID="Module.__py_scan"></a>
627 Private method to scan the source text of a Python module and retrieve 637 Private method to scan the source text of a Python module and retrieve
628 the relevant information. 638 the relevant information.
629 </p> 639 </p>
630 <dl> 640 <dl>
631 641
632 <dt><i>src</i></dt> 642 <dt><i>src</i> (str)</dt>
633 <dd> 643 <dd>
634 the source text to be scanned (string) 644 the source text to be scanned
635 </dd> 645 </dd>
636 </dl> 646 </dl>
637 <a NAME="Module.__py_setVisibility" ID="Module.__py_setVisibility"></a> 647 <a NAME="Module.__py_setVisibility" ID="Module.__py_setVisibility"></a>
638 <h4>Module.__py_setVisibility</h4> 648 <h4>Module.__py_setVisibility</h4>
639 <b>__py_setVisibility</b>(<i>objectRef</i>) 649 <b>__py_setVisibility</b>(<i>objectRef</i>)
641 <p> 651 <p>
642 Private method to set the visibility of an object. 652 Private method to set the visibility of an object.
643 </p> 653 </p>
644 <dl> 654 <dl>
645 655
646 <dt><i>objectRef</i></dt> 656 <dt><i>objectRef</i> (Attribute, Class or Function)</dt>
647 <dd> 657 <dd>
648 reference to the object (Attribute, Class or Function) 658 reference to the object
649 </dd> 659 </dd>
650 </dl> 660 </dl>
651 <a NAME="Module.__rb_scan" ID="Module.__rb_scan"></a> 661 <a NAME="Module.__rb_scan" ID="Module.__rb_scan"></a>
652 <h4>Module.__rb_scan</h4> 662 <h4>Module.__rb_scan</h4>
653 <b>__rb_scan</b>(<i>src</i>) 663 <b>__rb_scan</b>(<i>src</i>)
670 <p> 680 <p>
671 Public method to add information about a class. 681 Public method to add information about a class.
672 </p> 682 </p>
673 <dl> 683 <dl>
674 684
675 <dt><i>name</i></dt> 685 <dt><i>name</i> (str)</dt>
676 <dd> 686 <dd>
677 name of class to be added (string) 687 name of class to be added
678 </dd> 688 </dd>
679 <dt><i>_class</i></dt> 689 <dt><i>_class</i> (Class)</dt>
680 <dd> 690 <dd>
681 Class object to be added 691 Class object to be added
682 </dd> 692 </dd>
683 </dl> 693 </dl>
684 <a NAME="Module.addDescription" ID="Module.addDescription"></a> 694 <a NAME="Module.addDescription" ID="Module.addDescription"></a>
688 <p> 698 <p>
689 Public method to store the modules docstring. 699 Public method to store the modules docstring.
690 </p> 700 </p>
691 <dl> 701 <dl>
692 702
693 <dt><i>description</i></dt> 703 <dt><i>description</i> (str)</dt>
694 <dd> 704 <dd>
695 the docstring to be stored (string) 705 the docstring to be stored
696 </dd> 706 </dd>
697 </dl> 707 </dl>
698 <a NAME="Module.addFunction" ID="Module.addFunction"></a> 708 <a NAME="Module.addFunction" ID="Module.addFunction"></a>
699 <h4>Module.addFunction</h4> 709 <h4>Module.addFunction</h4>
700 <b>addFunction</b>(<i>name, function</i>) 710 <b>addFunction</b>(<i>name, function</i>)
702 <p> 712 <p>
703 Public method to add information about a function. 713 Public method to add information about a function.
704 </p> 714 </p>
705 <dl> 715 <dl>
706 716
707 <dt><i>name</i></dt> 717 <dt><i>name</i> (str)</dt>
708 <dd> 718 <dd>
709 name of function to be added (string) 719 name of function to be added
710 </dd> 720 </dd>
711 <dt><i>function</i></dt> 721 <dt><i>function</i> (Function)</dt>
712 <dd> 722 <dd>
713 Function object to be added 723 Function object to be added
714 </dd> 724 </dd>
715 </dl> 725 </dl>
716 <a NAME="Module.addGlobal" ID="Module.addGlobal"></a> 726 <a NAME="Module.addGlobal" ID="Module.addGlobal"></a>
720 <p> 730 <p>
721 Public method to add information about global variables. 731 Public method to add information about global variables.
722 </p> 732 </p>
723 <dl> 733 <dl>
724 734
725 <dt><i>name</i></dt> 735 <dt><i>name</i> (str)</dt>
726 <dd> 736 <dd>
727 name of the global to add (string) 737 name of the global to add
728 </dd> 738 </dd>
729 <dt><i>attr</i></dt> 739 <dt><i>attr</i> (Attribute)</dt>
730 <dd> 740 <dd>
731 Attribute object to be added 741 Attribute object to be added
732 </dd> 742 </dd>
733 </dl> 743 </dl>
734 <a NAME="Module.addModule" ID="Module.addModule"></a> 744 <a NAME="Module.addModule" ID="Module.addModule"></a>
738 <p> 748 <p>
739 Public method to add information about a Ruby module. 749 Public method to add information about a Ruby module.
740 </p> 750 </p>
741 <dl> 751 <dl>
742 752
743 <dt><i>name</i></dt> 753 <dt><i>name</i> (str)</dt>
744 <dd> 754 <dd>
745 name of module to be added (string) 755 name of module to be added
746 </dd> 756 </dd>
747 <dt><i>module</i></dt> 757 <dt><i>module</i> (Module)</dt>
748 <dd> 758 <dd>
749 Module object to be added 759 Module object to be added
750 </dd> 760 </dd>
751 </dl> 761 </dl>
752 <a NAME="Module.addPathToHierarchy" ID="Module.addPathToHierarchy"></a> 762 <a NAME="Module.addPathToHierarchy" ID="Module.addPathToHierarchy"></a>
756 <p> 766 <p>
757 Public method to put the exhausted path into the result dictionary. 767 Public method to put the exhausted path into the result dictionary.
758 </p> 768 </p>
759 <dl> 769 <dl>
760 770
761 <dt><i>path</i></dt> 771 <dt><i>path</i> (list of str)</dt>
762 <dd> 772 <dd>
763 the exhausted path of classes 773 the exhausted path of classes
764 </dd> 774 </dd>
765 <dt><i>result</i></dt> 775 <dt><i>result</i> (dict)</dt>
766 <dd> 776 <dd>
767 the result dictionary 777 the result dictionary
768 </dd> 778 </dd>
769 <dt><i>fn</i></dt> 779 <dt><i>fn</i> (function)</dt>
770 <dd> 780 <dd>
771 function to call for classe that are already part of the 781 function to call for classe that are already part of the
772 result dictionary 782 result dictionary
773 </dd> 783 </dd>
774 </dl> 784 </dl>
787 <p> 797 <p>
788 This code is borrowed from Boa Constructor. 798 This code is borrowed from Boa Constructor.
789 </p> 799 </p>
790 <dl> 800 <dl>
791 801
792 <dt><i>name</i></dt> 802 <dt><i>name</i> (str)</dt>
793 <dd> 803 <dd>
794 name of class to assemble hierarchy (string) 804 name of class to assemble hierarchy
795 </dd> 805 </dd>
796 <dt><i>classes</i></dt> 806 <dt><i>classes</i> (dict)</dt>
797 <dd> 807 <dd>
798 A dictionary of classes to look in. 808 A dictionary of classes to look in.
799 </dd> 809 </dd>
800 <dt><i>path</i></dt> 810 <dt><i>path</i> (list of str)</dt>
801 <dd> 811 <dd>
802 812 path of classes
803 </dd> 813 </dd>
804 <dt><i>result</i></dt> 814 <dt><i>result</i> (dict)</dt>
805 <dd> 815 <dd>
806 The resultant hierarchy 816 The resultant hierarchy
807 </dd> 817 </dd>
808 </dl> 818 </dl>
809 <a NAME="Module.calculateEndline" ID="Module.calculateEndline"></a> 819 <a NAME="Module.calculateEndline" ID="Module.calculateEndline"></a>
852 <dt>Return:</dt> 862 <dt>Return:</dt>
853 <dd> 863 <dd>
854 A dictionary with inheritance hierarchies. 864 A dictionary with inheritance hierarchies.
855 </dd> 865 </dd>
856 </dl> 866 </dl>
867 <dl>
868 <dt>Return Type:</dt>
869 <dd>
870 dict
871 </dd>
872 </dl>
857 <a NAME="Module.getFileName" ID="Module.getFileName"></a> 873 <a NAME="Module.getFileName" ID="Module.getFileName"></a>
858 <h4>Module.getFileName</h4> 874 <h4>Module.getFileName</h4>
859 <b>getFileName</b>(<i></i>) 875 <b>getFileName</b>(<i></i>)
860 876
861 <p> 877 <p>
862 Public method to retrieve the modules filename. 878 Public method to retrieve the modules filename.
863 </p> 879 </p>
864 <dl> 880 <dl>
865 <dt>Return:</dt> 881 <dt>Return:</dt>
866 <dd> 882 <dd>
867 module filename (string) 883 module filename
884 </dd>
885 </dl>
886 <dl>
887 <dt>Return Type:</dt>
888 <dd>
889 str
868 </dd> 890 </dd>
869 </dl> 891 </dl>
870 <a NAME="Module.getName" ID="Module.getName"></a> 892 <a NAME="Module.getName" ID="Module.getName"></a>
871 <h4>Module.getName</h4> 893 <h4>Module.getName</h4>
872 <b>getName</b>(<i></i>) 894 <b>getName</b>(<i></i>)
875 Public method to retrieve the modules name. 897 Public method to retrieve the modules name.
876 </p> 898 </p>
877 <dl> 899 <dl>
878 <dt>Return:</dt> 900 <dt>Return:</dt>
879 <dd> 901 <dd>
880 module name (string) 902 module name
903 </dd>
904 </dl>
905 <dl>
906 <dt>Return Type:</dt>
907 <dd>
908 str
881 </dd> 909 </dd>
882 </dl> 910 </dl>
883 <a NAME="Module.getType" ID="Module.getType"></a> 911 <a NAME="Module.getType" ID="Module.getType"></a>
884 <h4>Module.getType</h4> 912 <h4>Module.getType</h4>
885 <b>getType</b>(<i></i>) 913 <b>getType</b>(<i></i>)
888 Public method to get the type of the module's source. 916 Public method to get the type of the module's source.
889 </p> 917 </p>
890 <dl> 918 <dl>
891 <dt>Return:</dt> 919 <dt>Return:</dt>
892 <dd> 920 <dd>
893 type of the modules's source (string) 921 type of the modules's source
922 </dd>
923 </dl>
924 <dl>
925 <dt>Return Type:</dt>
926 <dd>
927 str
894 </dd> 928 </dd>
895 </dl> 929 </dl>
896 <a NAME="Module.scan" ID="Module.scan"></a> 930 <a NAME="Module.scan" ID="Module.scan"></a>
897 <h4>Module.scan</h4> 931 <h4>Module.scan</h4>
898 <b>scan</b>(<i>src</i>) 932 <b>scan</b>(<i>src</i>)
901 Public method to scan the source text and retrieve the relevant 935 Public method to scan the source text and retrieve the relevant
902 information. 936 information.
903 </p> 937 </p>
904 <dl> 938 <dl>
905 939
906 <dt><i>src</i></dt> 940 <dt><i>src</i> (str)</dt>
907 <dd> 941 <dd>
908 the source text to be scanned (string) 942 the source text to be scanned
909 </dd> 943 </dd>
910 </dl> 944 </dl>
911 <div align="right"><a href="#top">Up</a></div> 945 <div align="right"><a href="#top">Up</a></div>
912 <hr /> 946 <hr />
913 <hr /> 947 <hr />
955 <p> 989 <p>
956 Constructor 990 Constructor
957 </p> 991 </p>
958 <dl> 992 <dl>
959 993
960 <dt><i>module</i></dt> 994 <dt><i>module</i> (str)</dt>
961 <dd> 995 <dd>
962 name of module containing this class (string) 996 name of module containing this class
963 </dd> 997 </dd>
964 <dt><i>name</i></dt> 998 <dt><i>name</i> (str)</dt>
965 <dd> 999 <dd>
966 name of the class (string) 1000 name of the class
967 </dd> 1001 </dd>
968 <dt><i>file</i></dt> 1002 <dt><i>file</i> (str)</dt>
969 <dd> 1003 <dd>
970 name of file containing this class (string) 1004 name of file containing this class
971 </dd> 1005 </dd>
972 <dt><i>lineno</i></dt> 1006 <dt><i>lineno</i> (int)</dt>
973 <dd> 1007 <dd>
974 linenumber of the class definition (integer) 1008 linenumber of the class definition
975 </dd> 1009 </dd>
976 </dl> 1010 </dl>
977 <a NAME="RbModule.addClass" ID="RbModule.addClass"></a> 1011 <a NAME="RbModule.addClass" ID="RbModule.addClass"></a>
978 <h4>RbModule.addClass</h4> 1012 <h4>RbModule.addClass</h4>
979 <b>addClass</b>(<i>name, _class</i>) 1013 <b>addClass</b>(<i>name, _class</i>)
981 <p> 1015 <p>
982 Public method to add information about a class. 1016 Public method to add information about a class.
983 </p> 1017 </p>
984 <dl> 1018 <dl>
985 1019
986 <dt><i>name</i></dt> 1020 <dt><i>name</i> (str)</dt>
987 <dd> 1021 <dd>
988 name of class to be added (string) 1022 name of class to be added
989 </dd> 1023 </dd>
990 <dt><i>_class</i></dt> 1024 <dt><i>_class</i> (Class)</dt>
991 <dd> 1025 <dd>
992 Class object to be added 1026 Class object to be added
993 </dd> 1027 </dd>
994 </dl> 1028 </dl>
995 <div align="right"><a href="#top">Up</a></div> 1029 <div align="right"><a href="#top">Up</a></div>
1056 Public method to check, if the visibility is Private. 1090 Public method to check, if the visibility is Private.
1057 </p> 1091 </p>
1058 <dl> 1092 <dl>
1059 <dt>Return:</dt> 1093 <dt>Return:</dt>
1060 <dd> 1094 <dd>
1061 flag indicating Private visibility (boolean) 1095 flag indicating Private visibility
1096 </dd>
1097 </dl>
1098 <dl>
1099 <dt>Return Type:</dt>
1100 <dd>
1101 bool
1062 </dd> 1102 </dd>
1063 </dl> 1103 </dl>
1064 <a NAME="VisibilityBase.isProtected" ID="VisibilityBase.isProtected"></a> 1104 <a NAME="VisibilityBase.isProtected" ID="VisibilityBase.isProtected"></a>
1065 <h4>VisibilityBase.isProtected</h4> 1105 <h4>VisibilityBase.isProtected</h4>
1066 <b>isProtected</b>(<i></i>) 1106 <b>isProtected</b>(<i></i>)
1069 Public method to check, if the visibility is Protected. 1109 Public method to check, if the visibility is Protected.
1070 </p> 1110 </p>
1071 <dl> 1111 <dl>
1072 <dt>Return:</dt> 1112 <dt>Return:</dt>
1073 <dd> 1113 <dd>
1074 flag indicating Protected visibility (boolean) 1114 flag indicating Protected visibility
1115 </dd>
1116 </dl>
1117 <dl>
1118 <dt>Return Type:</dt>
1119 <dd>
1120 bool
1075 </dd> 1121 </dd>
1076 </dl> 1122 </dl>
1077 <a NAME="VisibilityBase.isPublic" ID="VisibilityBase.isPublic"></a> 1123 <a NAME="VisibilityBase.isPublic" ID="VisibilityBase.isPublic"></a>
1078 <h4>VisibilityBase.isPublic</h4> 1124 <h4>VisibilityBase.isPublic</h4>
1079 <b>isPublic</b>(<i></i>) 1125 <b>isPublic</b>(<i></i>)
1082 Public method to check, if the visibility is Public. 1128 Public method to check, if the visibility is Public.
1083 </p> 1129 </p>
1084 <dl> 1130 <dl>
1085 <dt>Return:</dt> 1131 <dt>Return:</dt>
1086 <dd> 1132 <dd>
1087 flag indicating Public visibility (boolean) 1133 flag indicating Public visibility
1134 </dd>
1135 </dl>
1136 <dl>
1137 <dt>Return Type:</dt>
1138 <dd>
1139 bool
1088 </dd> 1140 </dd>
1089 </dl> 1141 </dl>
1090 <a NAME="VisibilityBase.setPrivate" ID="VisibilityBase.setPrivate"></a> 1142 <a NAME="VisibilityBase.setPrivate" ID="VisibilityBase.setPrivate"></a>
1091 <h4>VisibilityBase.setPrivate</h4> 1143 <h4>VisibilityBase.setPrivate</h4>
1092 <b>setPrivate</b>(<i></i>) 1144 <b>setPrivate</b>(<i></i>)
1118 <p> 1170 <p>
1119 Protected function to determine the indent width of a whitespace string. 1171 Protected function to determine the indent width of a whitespace string.
1120 </p> 1172 </p>
1121 <dl> 1173 <dl>
1122 1174
1123 <dt><i>ws</i></dt> 1175 <dt><i>ws</i> (str)</dt>
1124 <dd> 1176 <dd>
1125 The whitespace string to be cheked. (string) 1177 The whitespace string to be cheked.
1126 </dd> 1178 </dd>
1127 </dl> 1179 </dl>
1128 <dl> 1180 <dl>
1129 <dt>Return:</dt> 1181 <dt>Return:</dt>
1130 <dd> 1182 <dd>
1131 Length of the whitespace string after tab expansion. 1183 length of the whitespace string after tab expansion
1184 </dd>
1185 </dl>
1186 <dl>
1187 <dt>Return Type:</dt>
1188 <dd>
1189 int
1132 </dd> 1190 </dd>
1133 </dl> 1191 </dl>
1134 <div align="right"><a href="#top">Up</a></div> 1192 <div align="right"><a href="#top">Up</a></div>
1135 <hr /> 1193 <hr />
1136 <hr /> 1194 <hr />
1147 implemented in the imp module is used. For all other supported files 1205 implemented in the imp module is used. For all other supported files
1148 only path is searched. 1206 only path is searched.
1149 </p> 1207 </p>
1150 <dl> 1208 <dl>
1151 1209
1152 <dt><i>name</i></dt> 1210 <dt><i>name</i> (str)</dt>
1153 <dd> 1211 <dd>
1154 filename or modulename to search for (string) 1212 filename or modulename to search for
1155 </dd> 1213 </dd>
1156 <dt><i>path</i></dt> 1214 <dt><i>path</i> (list of str)</dt>
1157 <dd> 1215 <dd>
1158 search path (list of strings) 1216 search path
1159 </dd> 1217 </dd>
1160 <dt><i>extensions</i></dt> 1218 <dt><i>extensions</i> (list of str)</dt>
1161 <dd> 1219 <dd>
1162 list of extensions, which should be considered valid 1220 list of extensions, which should be considered valid
1163 source file extensions (list of strings) 1221 source file extensions
1164 </dd> 1222 </dd>
1165 </dl> 1223 </dl>
1166 <dl> 1224 <dl>
1167 <dt>Return:</dt> 1225 <dt>Return:</dt>
1168 <dd> 1226 <dd>
1169 tuple of the open file, pathname and description. Description 1227 tuple of the open file, pathname and description. Description
1170 is a tuple of file suffix, file mode and file type) 1228 is a tuple of file suffix, file mode and file type)
1229 </dd>
1230 </dl>
1231 <dl>
1232 <dt>Return Type:</dt>
1233 <dd>
1234 tuple
1171 </dd> 1235 </dd>
1172 </dl> 1236 </dl>
1173 <dl> 1237 <dl>
1174 1238
1175 <dt>Raises <b>ImportError</b>:</dt> 1239 <dt>Raises <b>ImportError</b>:</dt>
1187 <p> 1251 <p>
1188 Module function to determine the module type given the module type name. 1252 Module function to determine the module type given the module type name.
1189 </p> 1253 </p>
1190 <dl> 1254 <dl>
1191 1255
1192 <dt><i>name</i></dt> 1256 <dt><i>name</i> (str)</dt>
1193 <dd> 1257 <dd>
1194 module type name (string) 1258 module type name
1195 </dd> 1259 </dd>
1196 </dl> 1260 </dl>
1197 <dl> 1261 <dl>
1198 <dt>Return:</dt> 1262 <dt>Return:</dt>
1199 <dd> 1263 <dd>
1200 module type or -1 for failure (integer) 1264 module type or -1 for failure
1265 </dd>
1266 </dl>
1267 <dl>
1268 <dt>Return Type:</dt>
1269 <dd>
1270 int
1201 </dd> 1271 </dd>
1202 </dl> 1272 </dl>
1203 <div align="right"><a href="#top">Up</a></div> 1273 <div align="right"><a href="#top">Up</a></div>
1204 <hr /> 1274 <hr />
1205 <hr /> 1275 <hr />
1215 If the module was parsed before, the information is taken 1285 If the module was parsed before, the information is taken
1216 from a cache in order to speed up processing. 1286 from a cache in order to speed up processing.
1217 </p> 1287 </p>
1218 <dl> 1288 <dl>
1219 1289
1220 <dt><i>module</i></dt> 1290 <dt><i>module</i> (str)</dt>
1221 <dd> 1291 <dd>
1222 name of the module to be parsed (string) 1292 name of the module to be parsed
1223 </dd> 1293 </dd>
1224 <dt><i>path</i></dt> 1294 <dt><i>path</i> (list of str)</dt>
1225 <dd> 1295 <dd>
1226 search path for the module (list of strings) 1296 search path for the module
1227 </dd> 1297 </dd>
1228 <dt><i>inpackage</i></dt> 1298 <dt><i>inpackage</i> (bool)</dt>
1229 <dd> 1299 <dd>
1230 flag indicating that module is inside a 1300 flag indicating that module is inside a
1231 package (boolean) 1301 package
1232 </dd> 1302 </dd>
1233 <dt><i>basename</i></dt> 1303 <dt><i>basename</i> (str)</dt>
1234 <dd> 1304 <dd>
1235 a path basename that is deleted from the filename of 1305 a path basename that is deleted from the filename of
1236 the module file to be read (string) 1306 the module file to be read
1237 </dd> 1307 </dd>
1238 <dt><i>extensions</i></dt> 1308 <dt><i>extensions</i> (list of str)</dt>
1239 <dd> 1309 <dd>
1240 list of extensions, which should be considered valid 1310 list of extensions, which should be considered valid
1241 source file extensions (list of strings) 1311 source file extensions
1242 </dd> 1312 </dd>
1243 <dt><i>caching</i></dt> 1313 <dt><i>caching</i> (bool)</dt>
1244 <dd> 1314 <dd>
1245 flag indicating that the parsed module should be 1315 flag indicating that the parsed module should be
1246 cached (boolean) 1316 cached
1247 </dd> 1317 </dd>
1248 <dt><i>ignoreBuiltinModules</i></dt> 1318 <dt><i>ignoreBuiltinModules</i> (bool)</dt>
1249 <dd> 1319 <dd>
1250 flag indicating to ignore the builtin modules 1320 flag indicating to ignore the builtin modules
1251 (boolean)
1252 </dd> 1321 </dd>
1253 </dl> 1322 </dl>
1254 <dl> 1323 <dl>
1255 <dt>Return:</dt> 1324 <dt>Return:</dt>
1256 <dd> 1325 <dd>
1257 reference to a Module object containing the parsed 1326 reference to a Module object containing the parsed
1258 module information (Module) 1327 module information
1328 </dd>
1329 </dl>
1330 <dl>
1331 <dt>Return Type:</dt>
1332 <dd>
1333 Module
1259 </dd> 1334 </dd>
1260 </dl> 1335 </dl>
1261 <div align="right"><a href="#top">Up</a></div> 1336 <div align="right"><a href="#top">Up</a></div>
1262 <hr /> 1337 <hr />
1263 <hr /> 1338 <hr />
1268 <p> 1343 <p>
1269 Module function to clear one module from the list of parsed modules. 1344 Module function to clear one module from the list of parsed modules.
1270 </p> 1345 </p>
1271 <dl> 1346 <dl>
1272 1347
1273 <dt><i>module</i></dt> 1348 <dt><i>module</i> (str)</dt>
1274 <dd> 1349 <dd>
1275 Name of the module to be parsed (string) 1350 Name of the module to be parsed
1276 </dd> 1351 </dd>
1277 <dt><i>basename</i></dt> 1352 <dt><i>basename</i> (str)</dt>
1278 <dd> 1353 <dd>
1279 a path basename. This basename is deleted from 1354 a path basename. This basename is deleted from
1280 the filename of the module file to be cleared. (string) 1355 the filename of the module file to be cleared.
1281 </dd> 1356 </dd>
1282 </dl> 1357 </dl>
1283 <div align="right"><a href="#top">Up</a></div> 1358 <div align="right"><a href="#top">Up</a></div>
1284 <hr /> 1359 <hr />
1285 <hr /> 1360 <hr />

Mercurial Repository: eric

eric ide

mercurial