Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Utilities.ClassBrowsers.idlclbr.html
Documentation/Source/eric5.Utilities.ClassBrowsers.idlclbr.html
- changeset 58
- 37f0444c3479
- parent 21
- b88a0e6268bd
- child 409
- 0ea528e80202
equal
deleted
inserted
replaced
| 57:81326a94fdca | 58:37f0444c3479 |
|---|---|
| 20 </style> | 20 </style> |
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.Utilities.ClassBrowsers.idlclbr</h1> | 23 <h1>eric5.Utilities.ClassBrowsers.idlclbr</h1> |
| 24 <p> | 24 <p> |
| 25 Parse a CORBA IDL file and retrieve modules, interfaces, methods and attributes. | 25 Parse a CORBA IDL file and retrieve modules, interfaces, methods and attributes. |
| 26 </p><p> | 26 </p><p> |
| 27 Parse enough of a CORBA IDL file to recognize module, interface and method definitions | 27 Parse enough of a CORBA IDL file to recognize module, interface and method definitions |
| 28 and to find out the superclasses of an interface as well as its attributes. | 28 and to find out the superclasses of an interface as well as its attributes. |
| 29 </p><p> | 29 </p><p> |
| 30 It is based on the Python class browser found in this package. | 30 It is based on the Python class browser found in this package. |
| 31 </p> | 31 </p> |
| 32 <h3>Global Attributes</h3> | 32 <h3>Global Attributes</h3> |
| 33 <table> | 33 <table> |
| 34 <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> | 34 <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> |
| 35 </table> | 35 </table> |
| 36 <h3>Classes</h3> | 36 <h3>Classes</h3> |
| 37 <table> | 37 <table> |
| 38 <tr> | 38 <tr> |
| 39 <td><a href="#Attribute">Attribute</a></td> | 39 <td><a href="#Attribute">Attribute</a></td> |
| 40 <td>Class to represent a CORBA IDL attribute.</td> | 40 <td>Class to represent a CORBA IDL attribute.</td> |
| 41 </tr><tr> | 41 </tr><tr> |
| 42 <td><a href="#Function">Function</a></td> | 42 <td><a href="#Function">Function</a></td> |
| 43 <td>Class to represent a CORBA IDL function.</td> | 43 <td>Class to represent a CORBA IDL function.</td> |
| 44 </tr><tr> | 44 </tr><tr> |
| 45 <td><a href="#Interface">Interface</a></td> | 45 <td><a href="#Interface">Interface</a></td> |
| 46 <td>Class to represent a CORBA IDL interface.</td> | 46 <td>Class to represent a CORBA IDL interface.</td> |
| 47 </tr><tr> | 47 </tr><tr> |
| 48 <td><a href="#Module">Module</a></td> | 48 <td><a href="#Module">Module</a></td> |
| 49 <td>Class to represent a CORBA IDL module.</td> | 49 <td>Class to represent a CORBA IDL module.</td> |
| 50 </tr><tr> | 50 </tr><tr> |
| 51 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> | 51 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> |
| 52 <td>Mixin class implementing the notion of visibility.</td> | 52 <td>Mixin class implementing the notion of visibility.</td> |
| 53 </tr> | 53 </tr> |
| 54 </table> | 54 </table> |
| 55 <h3>Functions</h3> | 55 <h3>Functions</h3> |
| 56 <table> | 56 <table> |
| 57 <tr> | 57 <tr> |
| 58 <td><a href="#readmodule_ex">readmodule_ex</a></td> | 58 <td><a href="#readmodule_ex">readmodule_ex</a></td> |
| 59 <td>Read a CORBA IDL file and return a dictionary of classes, functions and modules.</td> | 59 <td>Read a CORBA IDL file and return a dictionary of classes, functions and modules.</td> |
| 60 </tr> | 60 </tr> |
| 61 </table> | 61 </table> |
| 62 <hr /><hr /> | 62 <hr /><hr /> |
| 63 <a NAME="Attribute" ID="Attribute"></a> | 63 <a NAME="Attribute" ID="Attribute"></a> |
| 64 <h2>Attribute</h2> | 64 <h2>Attribute</h2> |
| 65 <p> | 65 <p> |
| 66 Class to represent a CORBA IDL attribute. | 66 Class to represent a CORBA IDL attribute. |
| 67 </p> | 67 </p> |
| 68 <h3>Derived from</h3> | 68 <h3>Derived from</h3> |
| 69 ClbrBaseClasses.Attribute, VisibilityMixin | 69 ClbrBaseClasses.Attribute, VisibilityMixin |
| 70 <h3>Class Attributes</h3> | 70 <h3>Class Attributes</h3> |
| 71 <table> | 71 <table> |
| 73 </table> | 73 </table> |
| 74 <h3>Methods</h3> | 74 <h3>Methods</h3> |
| 75 <table> | 75 <table> |
| 76 <tr> | 76 <tr> |
| 77 <td><a href="#Attribute.__init__">Attribute</a></td> | 77 <td><a href="#Attribute.__init__">Attribute</a></td> |
| 78 <td>Constructor</td> | 78 <td>Constructor</td> |
| 79 </tr> | 79 </tr> |
| 80 </table> | 80 </table> |
| 81 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> | 81 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> |
| 82 <h4>Attribute (Constructor)</h4> | 82 <h4>Attribute (Constructor)</h4> |
| 83 <b>Attribute</b>(<i>module, name, file, lineno</i>) | 83 <b>Attribute</b>(<i>module, name, file, lineno</i>) |
| 84 <p> | 84 <p> |
| 85 Constructor | 85 Constructor |
| 86 </p><dl> | 86 </p><dl> |
| 87 <dt><i>module</i></dt> | 87 <dt><i>module</i></dt> |
| 88 <dd> | 88 <dd> |
| 89 name of the module containing this class | 89 name of the module containing this class |
| 90 </dd><dt><i>name</i></dt> | 90 </dd><dt><i>name</i></dt> |
| 91 <dd> | 91 <dd> |
| 92 name of this class | 92 name of this class |
| 93 </dd><dt><i>file</i></dt> | 93 </dd><dt><i>file</i></dt> |
| 94 <dd> | 94 <dd> |
| 95 filename containing this attribute | 95 filename containing this attribute |
| 96 </dd><dt><i>lineno</i></dt> | 96 </dd><dt><i>lineno</i></dt> |
| 97 <dd> | 97 <dd> |
| 98 linenumber of the class definition | 98 linenumber of the class definition |
| 99 </dd> | 99 </dd> |
| 100 </dl> | 100 </dl> |
| 101 <div align="right"><a href="#top">Up</a></div> | 101 <div align="right"><a href="#top">Up</a></div> |
| 102 <hr /><hr /> | 102 <hr /><hr /> |
| 103 <a NAME="Function" ID="Function"></a> | 103 <a NAME="Function" ID="Function"></a> |
| 104 <h2>Function</h2> | 104 <h2>Function</h2> |
| 105 <p> | 105 <p> |
| 106 Class to represent a CORBA IDL function. | 106 Class to represent a CORBA IDL function. |
| 107 </p> | 107 </p> |
| 108 <h3>Derived from</h3> | 108 <h3>Derived from</h3> |
| 109 ClbrBaseClasses.Function, VisibilityMixin | 109 ClbrBaseClasses.Function, VisibilityMixin |
| 110 <h3>Class Attributes</h3> | 110 <h3>Class Attributes</h3> |
| 111 <table> | 111 <table> |
| 113 </table> | 113 </table> |
| 114 <h3>Methods</h3> | 114 <h3>Methods</h3> |
| 115 <table> | 115 <table> |
| 116 <tr> | 116 <tr> |
| 117 <td><a href="#Function.__init__">Function</a></td> | 117 <td><a href="#Function.__init__">Function</a></td> |
| 118 <td>Constructor</td> | 118 <td>Constructor</td> |
| 119 </tr> | 119 </tr> |
| 120 </table> | 120 </table> |
| 121 <a NAME="Function.__init__" ID="Function.__init__"></a> | 121 <a NAME="Function.__init__" ID="Function.__init__"></a> |
| 122 <h4>Function (Constructor)</h4> | 122 <h4>Function (Constructor)</h4> |
| 123 <b>Function</b>(<i>module, name, file, lineno, signature = '', separator = ', '</i>) | 123 <b>Function</b>(<i>module, name, file, lineno, signature = '', separator = ', '</i>) |
| 124 <p> | 124 <p> |
| 125 Constructor | 125 Constructor |
| 126 </p><dl> | 126 </p><dl> |
| 127 <dt><i>module</i></dt> | 127 <dt><i>module</i></dt> |
| 128 <dd> | 128 <dd> |
| 129 name of the module containing this function | 129 name of the module containing this function |
| 130 </dd><dt><i>name</i></dt> | 130 </dd><dt><i>name</i></dt> |
| 131 <dd> | 131 <dd> |
| 132 name of this function | 132 name of this function |
| 133 </dd><dt><i>file</i></dt> | 133 </dd><dt><i>file</i></dt> |
| 134 <dd> | 134 <dd> |
| 135 filename containing this class | 135 filename containing this class |
| 136 </dd><dt><i>lineno</i></dt> | 136 </dd><dt><i>lineno</i></dt> |
| 137 <dd> | 137 <dd> |
| 138 linenumber of the class definition | 138 linenumber of the class definition |
| 139 </dd><dt><i>signature</i></dt> | 139 </dd><dt><i>signature</i></dt> |
| 140 <dd> | 140 <dd> |
| 141 parameterlist of the method | 141 parameterlist of the method |
| 142 </dd><dt><i>separator</i></dt> | 142 </dd><dt><i>separator</i></dt> |
| 143 <dd> | 143 <dd> |
| 144 string separating the parameters | 144 string separating the parameters |
| 145 </dd> | 145 </dd> |
| 146 </dl> | 146 </dl> |
| 147 <div align="right"><a href="#top">Up</a></div> | 147 <div align="right"><a href="#top">Up</a></div> |
| 148 <hr /><hr /> | 148 <hr /><hr /> |
| 149 <a NAME="Interface" ID="Interface"></a> | 149 <a NAME="Interface" ID="Interface"></a> |
| 150 <h2>Interface</h2> | 150 <h2>Interface</h2> |
| 151 <p> | 151 <p> |
| 152 Class to represent a CORBA IDL interface. | 152 Class to represent a CORBA IDL interface. |
| 153 </p> | 153 </p> |
| 154 <h3>Derived from</h3> | 154 <h3>Derived from</h3> |
| 155 ClbrBaseClasses.Class, VisibilityMixin | 155 ClbrBaseClasses.Class, VisibilityMixin |
| 156 <h3>Class Attributes</h3> | 156 <h3>Class Attributes</h3> |
| 157 <table> | 157 <table> |
| 159 </table> | 159 </table> |
| 160 <h3>Methods</h3> | 160 <h3>Methods</h3> |
| 161 <table> | 161 <table> |
| 162 <tr> | 162 <tr> |
| 163 <td><a href="#Interface.__init__">Interface</a></td> | 163 <td><a href="#Interface.__init__">Interface</a></td> |
| 164 <td>Constructor</td> | 164 <td>Constructor</td> |
| 165 </tr> | 165 </tr> |
| 166 </table> | 166 </table> |
| 167 <a NAME="Interface.__init__" ID="Interface.__init__"></a> | 167 <a NAME="Interface.__init__" ID="Interface.__init__"></a> |
| 168 <h4>Interface (Constructor)</h4> | 168 <h4>Interface (Constructor)</h4> |
| 169 <b>Interface</b>(<i>module, name, super, file, lineno</i>) | 169 <b>Interface</b>(<i>module, name, super, file, lineno</i>) |
| 170 <p> | 170 <p> |
| 171 Constructor | 171 Constructor |
| 172 </p><dl> | 172 </p><dl> |
| 173 <dt><i>module</i></dt> | 173 <dt><i>module</i></dt> |
| 174 <dd> | 174 <dd> |
| 175 name of the module containing this class | 175 name of the module containing this class |
| 176 </dd><dt><i>name</i></dt> | 176 </dd><dt><i>name</i></dt> |
| 177 <dd> | 177 <dd> |
| 178 name of this interface | 178 name of this interface |
| 179 </dd><dt><i>super</i></dt> | 179 </dd><dt><i>super</i></dt> |
| 180 <dd> | 180 <dd> |
| 181 list of interface names this interface is inherited from | 181 list of interface names this interface is inherited from |
| 182 </dd><dt><i>file</i></dt> | 182 </dd><dt><i>file</i></dt> |
| 183 <dd> | 183 <dd> |
| 184 filename containing this interface | 184 filename containing this interface |
| 185 </dd><dt><i>lineno</i></dt> | 185 </dd><dt><i>lineno</i></dt> |
| 186 <dd> | 186 <dd> |
| 187 linenumber of the interface definition | 187 linenumber of the interface definition |
| 188 </dd> | 188 </dd> |
| 189 </dl> | 189 </dl> |
| 190 <div align="right"><a href="#top">Up</a></div> | 190 <div align="right"><a href="#top">Up</a></div> |
| 191 <hr /><hr /> | 191 <hr /><hr /> |
| 192 <a NAME="Module" ID="Module"></a> | 192 <a NAME="Module" ID="Module"></a> |
| 193 <h2>Module</h2> | 193 <h2>Module</h2> |
| 194 <p> | 194 <p> |
| 195 Class to represent a CORBA IDL module. | 195 Class to represent a CORBA IDL module. |
| 196 </p> | 196 </p> |
| 197 <h3>Derived from</h3> | 197 <h3>Derived from</h3> |
| 198 ClbrBaseClasses.Module, VisibilityMixin | 198 ClbrBaseClasses.Module, VisibilityMixin |
| 199 <h3>Class Attributes</h3> | 199 <h3>Class Attributes</h3> |
| 200 <table> | 200 <table> |
| 202 </table> | 202 </table> |
| 203 <h3>Methods</h3> | 203 <h3>Methods</h3> |
| 204 <table> | 204 <table> |
| 205 <tr> | 205 <tr> |
| 206 <td><a href="#Module.__init__">Module</a></td> | 206 <td><a href="#Module.__init__">Module</a></td> |
| 207 <td>Constructor</td> | 207 <td>Constructor</td> |
| 208 </tr> | 208 </tr> |
| 209 </table> | 209 </table> |
| 210 <a NAME="Module.__init__" ID="Module.__init__"></a> | 210 <a NAME="Module.__init__" ID="Module.__init__"></a> |
| 211 <h4>Module (Constructor)</h4> | 211 <h4>Module (Constructor)</h4> |
| 212 <b>Module</b>(<i>module, name, file, lineno</i>) | 212 <b>Module</b>(<i>module, name, file, lineno</i>) |
| 213 <p> | 213 <p> |
| 214 Constructor | 214 Constructor |
| 215 </p><dl> | 215 </p><dl> |
| 216 <dt><i>module</i></dt> | 216 <dt><i>module</i></dt> |
| 217 <dd> | 217 <dd> |
| 218 name of the module containing this class | 218 name of the module containing this class |
| 219 </dd><dt><i>name</i></dt> | 219 </dd><dt><i>name</i></dt> |
| 220 <dd> | 220 <dd> |
| 221 name of this class | 221 name of this class |
| 222 </dd><dt><i>file</i></dt> | 222 </dd><dt><i>file</i></dt> |
| 223 <dd> | 223 <dd> |
| 224 filename containing this class | 224 filename containing this class |
| 225 </dd><dt><i>lineno</i></dt> | 225 </dd><dt><i>lineno</i></dt> |
| 226 <dd> | 226 <dd> |
| 227 linenumber of the class definition | 227 linenumber of the class definition |
| 228 </dd> | 228 </dd> |
| 229 </dl> | 229 </dl> |
| 230 <div align="right"><a href="#top">Up</a></div> | 230 <div align="right"><a href="#top">Up</a></div> |
| 231 <hr /><hr /> | 231 <hr /><hr /> |
| 232 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> | 232 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> |
| 233 <h2>VisibilityMixin</h2> | 233 <h2>VisibilityMixin</h2> |
| 234 <p> | 234 <p> |
| 235 Mixin class implementing the notion of visibility. | 235 Mixin class implementing the notion of visibility. |
| 236 </p> | 236 </p> |
| 237 <h3>Derived from</h3> | 237 <h3>Derived from</h3> |
| 238 ClbrBaseClasses.ClbrVisibilityMixinBase | 238 ClbrBaseClasses.ClbrVisibilityMixinBase |
| 239 <h3>Class Attributes</h3> | 239 <h3>Class Attributes</h3> |
| 240 <table> | 240 <table> |
| 242 </table> | 242 </table> |
| 243 <h3>Methods</h3> | 243 <h3>Methods</h3> |
| 244 <table> | 244 <table> |
| 245 <tr> | 245 <tr> |
| 246 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> | 246 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> |
| 247 <td>Method to initialize the visibility.</td> | 247 <td>Method to initialize the visibility.</td> |
| 248 </tr> | 248 </tr> |
| 249 </table> | 249 </table> |
| 250 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> | 250 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> |
| 251 <h4>VisibilityMixin (Constructor)</h4> | 251 <h4>VisibilityMixin (Constructor)</h4> |
| 252 <b>VisibilityMixin</b>(<i></i>) | 252 <b>VisibilityMixin</b>(<i></i>) |
| 253 <p> | 253 <p> |
| 254 Method to initialize the visibility. | 254 Method to initialize the visibility. |
| 255 </p> | 255 </p> |
| 256 <div align="right"><a href="#top">Up</a></div> | 256 <div align="right"><a href="#top">Up</a></div> |
| 257 <hr /><hr /> | 257 <hr /><hr /> |
| 258 <a NAME="readmodule_ex" ID="readmodule_ex"></a> | 258 <a NAME="readmodule_ex" ID="readmodule_ex"></a> |
| 259 <h2>readmodule_ex</h2> | 259 <h2>readmodule_ex</h2> |
| 260 <b>readmodule_ex</b>(<i>module, path=[]</i>) | 260 <b>readmodule_ex</b>(<i>module, path=[]</i>) |
| 261 <p> | 261 <p> |
| 262 Read a CORBA IDL file and return a dictionary of classes, functions and modules. | 262 Read a CORBA IDL file and return a dictionary of classes, functions and modules. |
| 263 </p><dl> | 263 </p><dl> |
| 264 <dt><i>module</i></dt> | 264 <dt><i>module</i></dt> |
| 265 <dd> | 265 <dd> |
| 266 name of the CORBA IDL file (string) | 266 name of the CORBA IDL file (string) |
| 267 </dd><dt><i>path</i></dt> | 267 </dd><dt><i>path</i></dt> |
| 268 <dd> | 268 <dd> |
| 269 path the file should be searched in (list of strings) | 269 path the file should be searched in (list of strings) |
| 270 </dd> | 270 </dd> |
| 271 </dl><dl> | 271 </dl><dl> |
| 272 <dt>Returns:</dt> | 272 <dt>Returns:</dt> |
| 273 <dd> | 273 <dd> |
| 274 the resulting dictionary | 274 the resulting dictionary |
| 275 </dd> | 275 </dd> |
| 276 </dl> | 276 </dl> |
| 277 <div align="right"><a href="#top">Up</a></div> | 277 <div align="right"><a href="#top">Up</a></div> |
| 278 <hr /> | 278 <hr /> |
| 279 </body></html> | 279 </body></html> |
