eric6/Documentation/Source/eric6.Utilities.ClassBrowsers.jsclbr.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7693
a51f82458a1b
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
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.jsclbr</h1> 23 <h1>eric6.Utilities.ClassBrowsers.jsclbr</h1>
24
23 <p> 25 <p>
24 Parse a JavaScript file and retrieve variables and functions. 26 Parse a JavaScript file and retrieve variables and functions.
25 </p><p> 27 </p>
28 <p>
26 It uses the JavaScript parser contained in the jasy web framework. 29 It uses the JavaScript parser contained in the jasy web framework.
27 </p> 30 </p>
28 <h3>Global Attributes</h3> 31 <h3>Global Attributes</h3>
32
29 <table> 33 <table>
30 <tr><td>SUPPORTED_TYPES</td></tr><tr><td>_modules</td></tr> 34 <tr><td>SUPPORTED_TYPES</td></tr><tr><td>_modules</td></tr>
31 </table> 35 </table>
32 <h3>Classes</h3> 36 <h3>Classes</h3>
33 <table> 37
38 <table>
39
34 <tr> 40 <tr>
35 <td><a href="#Attribute">Attribute</a></td> 41 <td><a href="#Attribute">Attribute</a></td>
36 <td>Class to represent a class attribute.</td> 42 <td>Class to represent a class attribute.</td>
37 </tr><tr> 43 </tr>
44 <tr>
38 <td><a href="#Function">Function</a></td> 45 <td><a href="#Function">Function</a></td>
39 <td>Class to represent a Python function.</td> 46 <td>Class to represent a Python function.</td>
40 </tr><tr> 47 </tr>
48 <tr>
41 <td><a href="#VisibilityMixin">VisibilityMixin</a></td> 49 <td><a href="#VisibilityMixin">VisibilityMixin</a></td>
42 <td>Mixin class implementing the notion of visibility.</td> 50 <td>Mixin class implementing the notion of visibility.</td>
43 </tr><tr> 51 </tr>
52 <tr>
44 <td><a href="#Visitor">Visitor</a></td> 53 <td><a href="#Visitor">Visitor</a></td>
45 <td>Class implementing a visitor going through the parsed tree.</td> 54 <td>Class implementing a visitor going through the parsed tree.</td>
46 </tr> 55 </tr>
47 </table> 56 </table>
48 <h3>Functions</h3> 57 <h3>Functions</h3>
49 <table> 58
59 <table>
60
50 <tr> 61 <tr>
51 <td><a href="#readmodule_ex">readmodule_ex</a></td> 62 <td><a href="#readmodule_ex">readmodule_ex</a></td>
52 <td>Read a JavaScript file and return a dictionary of functions and variables.</td> 63 <td>Read a JavaScript file and return a dictionary of functions and variables.</td>
53 </tr> 64 </tr>
54 </table> 65 </table>
55 <hr /><hr /> 66 <hr />
67 <hr />
56 <a NAME="Attribute" ID="Attribute"></a> 68 <a NAME="Attribute" ID="Attribute"></a>
57 <h2>Attribute</h2> 69 <h2>Attribute</h2>
70
58 <p> 71 <p>
59 Class to represent a class attribute. 72 Class to represent a class attribute.
60 </p> 73 </p>
61 <h3>Derived from</h3> 74 <h3>Derived from</h3>
62 ClbrBaseClasses.Attribute, VisibilityMixin 75 ClbrBaseClasses.Attribute, VisibilityMixin
63 <h3>Class Attributes</h3> 76 <h3>Class Attributes</h3>
77
64 <table> 78 <table>
65 <tr><td>None</td></tr> 79 <tr><td>None</td></tr>
66 </table> 80 </table>
67 <h3>Class Methods</h3> 81 <h3>Class Methods</h3>
82
68 <table> 83 <table>
69 <tr><td>None</td></tr> 84 <tr><td>None</td></tr>
70 </table> 85 </table>
71 <h3>Methods</h3> 86 <h3>Methods</h3>
72 <table> 87
88 <table>
89
73 <tr> 90 <tr>
74 <td><a href="#Attribute.__init__">Attribute</a></td> 91 <td><a href="#Attribute.__init__">Attribute</a></td>
75 <td>Constructor</td> 92 <td>Constructor</td>
76 </tr> 93 </tr>
77 </table> 94 </table>
78 <h3>Static Methods</h3> 95 <h3>Static Methods</h3>
79 <table> 96
80 <tr><td>None</td></tr> 97 <table>
81 </table> 98 <tr><td>None</td></tr>
99 </table>
100
82 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a> 101 <a NAME="Attribute.__init__" ID="Attribute.__init__"></a>
83 <h4>Attribute (Constructor)</h4> 102 <h4>Attribute (Constructor)</h4>
84 <b>Attribute</b>(<i>module, name, file, lineno</i>) 103 <b>Attribute</b>(<i>module, name, file, lineno</i>)
104
85 <p> 105 <p>
86 Constructor 106 Constructor
87 </p><dl> 107 </p>
108 <dl>
109
88 <dt><i>module</i></dt> 110 <dt><i>module</i></dt>
89 <dd> 111 <dd>
90 name of the module containing this class 112 name of the module containing this class
91 </dd><dt><i>name</i></dt> 113 </dd>
114 <dt><i>name</i></dt>
92 <dd> 115 <dd>
93 name of this class 116 name of this class
94 </dd><dt><i>file</i></dt> 117 </dd>
118 <dt><i>file</i></dt>
95 <dd> 119 <dd>
96 filename containing this attribute 120 filename containing this attribute
97 </dd><dt><i>lineno</i></dt> 121 </dd>
122 <dt><i>lineno</i></dt>
98 <dd> 123 <dd>
99 linenumber of the class definition 124 linenumber of the class definition
100 </dd> 125 </dd>
101 </dl> 126 </dl>
102 <div align="right"><a href="#top">Up</a></div> 127 <div align="right"><a href="#top">Up</a></div>
103 <hr /><hr /> 128 <hr />
129 <hr />
104 <a NAME="Function" ID="Function"></a> 130 <a NAME="Function" ID="Function"></a>
105 <h2>Function</h2> 131 <h2>Function</h2>
132
106 <p> 133 <p>
107 Class to represent a Python function. 134 Class to represent a Python function.
108 </p> 135 </p>
109 <h3>Derived from</h3> 136 <h3>Derived from</h3>
110 ClbrBaseClasses.Function, VisibilityMixin 137 ClbrBaseClasses.Function, VisibilityMixin
111 <h3>Class Attributes</h3> 138 <h3>Class Attributes</h3>
139
112 <table> 140 <table>
113 <tr><td>None</td></tr> 141 <tr><td>None</td></tr>
114 </table> 142 </table>
115 <h3>Class Methods</h3> 143 <h3>Class Methods</h3>
144
116 <table> 145 <table>
117 <tr><td>None</td></tr> 146 <tr><td>None</td></tr>
118 </table> 147 </table>
119 <h3>Methods</h3> 148 <h3>Methods</h3>
120 <table> 149
150 <table>
151
121 <tr> 152 <tr>
122 <td><a href="#Function.__init__">Function</a></td> 153 <td><a href="#Function.__init__">Function</a></td>
123 <td>Constructor</td> 154 <td>Constructor</td>
124 </tr> 155 </tr>
125 </table> 156 </table>
126 <h3>Static Methods</h3> 157 <h3>Static Methods</h3>
127 <table> 158
128 <tr><td>None</td></tr> 159 <table>
129 </table> 160 <tr><td>None</td></tr>
161 </table>
162
130 <a NAME="Function.__init__" ID="Function.__init__"></a> 163 <a NAME="Function.__init__" ID="Function.__init__"></a>
131 <h4>Function (Constructor)</h4> 164 <h4>Function (Constructor)</h4>
132 <b>Function</b>(<i>module, name, file, lineno, signature='', separator=', '</i>) 165 <b>Function</b>(<i>module, name, file, lineno, signature='', separator=', '</i>)
166
133 <p> 167 <p>
134 Constructor 168 Constructor
135 </p><dl> 169 </p>
170 <dl>
171
136 <dt><i>module</i></dt> 172 <dt><i>module</i></dt>
137 <dd> 173 <dd>
138 name of the module containing this function 174 name of the module containing this function
139 </dd><dt><i>name</i></dt> 175 </dd>
176 <dt><i>name</i></dt>
140 <dd> 177 <dd>
141 name of this function 178 name of this function
142 </dd><dt><i>file</i></dt> 179 </dd>
180 <dt><i>file</i></dt>
143 <dd> 181 <dd>
144 filename containing this class 182 filename containing this class
145 </dd><dt><i>lineno</i></dt> 183 </dd>
184 <dt><i>lineno</i></dt>
146 <dd> 185 <dd>
147 linenumber of the class definition 186 linenumber of the class definition
148 </dd><dt><i>signature</i></dt> 187 </dd>
188 <dt><i>signature</i></dt>
149 <dd> 189 <dd>
150 parameterlist of the method 190 parameterlist of the method
151 </dd><dt><i>separator</i></dt> 191 </dd>
192 <dt><i>separator</i></dt>
152 <dd> 193 <dd>
153 string separating the parameters 194 string separating the parameters
154 </dd> 195 </dd>
155 </dl> 196 </dl>
156 <div align="right"><a href="#top">Up</a></div> 197 <div align="right"><a href="#top">Up</a></div>
157 <hr /><hr /> 198 <hr />
199 <hr />
158 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a> 200 <a NAME="VisibilityMixin" ID="VisibilityMixin"></a>
159 <h2>VisibilityMixin</h2> 201 <h2>VisibilityMixin</h2>
202
160 <p> 203 <p>
161 Mixin class implementing the notion of visibility. 204 Mixin class implementing the notion of visibility.
162 </p> 205 </p>
163 <h3>Derived from</h3> 206 <h3>Derived from</h3>
164 ClbrBaseClasses.ClbrVisibilityMixinBase 207 ClbrBaseClasses.ClbrVisibilityMixinBase
165 <h3>Class Attributes</h3> 208 <h3>Class Attributes</h3>
209
166 <table> 210 <table>
167 <tr><td>None</td></tr> 211 <tr><td>None</td></tr>
168 </table> 212 </table>
169 <h3>Class Methods</h3> 213 <h3>Class Methods</h3>
214
170 <table> 215 <table>
171 <tr><td>None</td></tr> 216 <tr><td>None</td></tr>
172 </table> 217 </table>
173 <h3>Methods</h3> 218 <h3>Methods</h3>
174 <table> 219
220 <table>
221
175 <tr> 222 <tr>
176 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td> 223 <td><a href="#VisibilityMixin.__init__">VisibilityMixin</a></td>
177 <td>Constructor</td> 224 <td>Constructor</td>
178 </tr> 225 </tr>
179 </table> 226 </table>
180 <h3>Static Methods</h3> 227 <h3>Static Methods</h3>
181 <table> 228
182 <tr><td>None</td></tr> 229 <table>
183 </table> 230 <tr><td>None</td></tr>
231 </table>
232
184 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a> 233 <a NAME="VisibilityMixin.__init__" ID="VisibilityMixin.__init__"></a>
185 <h4>VisibilityMixin (Constructor)</h4> 234 <h4>VisibilityMixin (Constructor)</h4>
186 <b>VisibilityMixin</b>(<i></i>) 235 <b>VisibilityMixin</b>(<i></i>)
236
187 <p> 237 <p>
188 Constructor 238 Constructor
189 </p> 239 </p>
190 <div align="right"><a href="#top">Up</a></div> 240 <div align="right"><a href="#top">Up</a></div>
191 <hr /><hr /> 241 <hr />
242 <hr />
192 <a NAME="Visitor" ID="Visitor"></a> 243 <a NAME="Visitor" ID="Visitor"></a>
193 <h2>Visitor</h2> 244 <h2>Visitor</h2>
245
194 <p> 246 <p>
195 Class implementing a visitor going through the parsed tree. 247 Class implementing a visitor going through the parsed tree.
196 </p> 248 </p>
197 <h3>Derived from</h3> 249 <h3>Derived from</h3>
198 object 250 object
199 <h3>Class Attributes</h3> 251 <h3>Class Attributes</h3>
252
200 <table> 253 <table>
201 <tr><td>None</td></tr> 254 <tr><td>None</td></tr>
202 </table> 255 </table>
203 <h3>Class Methods</h3> 256 <h3>Class Methods</h3>
257
204 <table> 258 <table>
205 <tr><td>None</td></tr> 259 <tr><td>None</td></tr>
206 </table> 260 </table>
207 <h3>Methods</h3> 261 <h3>Methods</h3>
208 <table> 262
263 <table>
264
209 <tr> 265 <tr>
210 <td><a href="#Visitor.__init__">Visitor</a></td> 266 <td><a href="#Visitor.__init__">Visitor</a></td>
211 <td>Constructor</td> 267 <td>Constructor</td>
212 </tr><tr> 268 </tr>
269 <tr>
213 <td><a href="#Visitor.__visit">__visit</a></td> 270 <td><a href="#Visitor.__visit">__visit</a></td>
214 <td>Private method implementing the visit logic delegating to interesting methods.</td> 271 <td>Private method implementing the visit logic delegating to interesting methods.</td>
215 </tr><tr> 272 </tr>
273 <tr>
216 <td><a href="#Visitor.call">call</a></td> 274 <td><a href="#Visitor.call">call</a></td>
217 <td></td> 275 <td></td>
218 </tr><tr> 276 </tr>
277 <tr>
219 <td><a href="#Visitor.parse">parse</a></td> 278 <td><a href="#Visitor.parse">parse</a></td>
220 <td>Public method to parse the source.</td> 279 <td>Public method to parse the source.</td>
221 </tr><tr> 280 </tr>
281 <tr>
222 <td><a href="#Visitor.visit_const">visit_const</a></td> 282 <td><a href="#Visitor.visit_const">visit_const</a></td>
223 <td>Public method to treat a constant node.</td> 283 <td>Public method to treat a constant node.</td>
224 </tr><tr> 284 </tr>
285 <tr>
225 <td><a href="#Visitor.visit_function">visit_function</a></td> 286 <td><a href="#Visitor.visit_function">visit_function</a></td>
226 <td>Public method to treat a function node.</td> 287 <td>Public method to treat a function node.</td>
227 </tr><tr> 288 </tr>
289 <tr>
228 <td><a href="#Visitor.visit_noop">visit_noop</a></td> 290 <td><a href="#Visitor.visit_noop">visit_noop</a></td>
229 <td>Public method to ignore the given node.</td> 291 <td>Public method to ignore the given node.</td>
230 </tr><tr> 292 </tr>
293 <tr>
231 <td><a href="#Visitor.visit_property_init">visit_property_init</a></td> 294 <td><a href="#Visitor.visit_property_init">visit_property_init</a></td>
232 <td>Public method to treat a property_init node.</td> 295 <td>Public method to treat a property_init node.</td>
233 </tr><tr> 296 </tr>
297 <tr>
234 <td><a href="#Visitor.visit_var">visit_var</a></td> 298 <td><a href="#Visitor.visit_var">visit_var</a></td>
235 <td>Public method to treat a variable node.</td> 299 <td>Public method to treat a variable node.</td>
236 </tr> 300 </tr>
237 </table> 301 </table>
238 <h3>Static Methods</h3> 302 <h3>Static Methods</h3>
239 <table> 303
240 <tr><td>None</td></tr> 304 <table>
241 </table> 305 <tr><td>None</td></tr>
306 </table>
307
242 <a NAME="Visitor.__init__" ID="Visitor.__init__"></a> 308 <a NAME="Visitor.__init__" ID="Visitor.__init__"></a>
243 <h4>Visitor (Constructor)</h4> 309 <h4>Visitor (Constructor)</h4>
244 <b>Visitor</b>(<i>src, module, filename</i>) 310 <b>Visitor</b>(<i>src, module, filename</i>)
311
245 <p> 312 <p>
246 Constructor 313 Constructor
247 </p><dl> 314 </p>
315 <dl>
316
248 <dt><i>src</i></dt> 317 <dt><i>src</i></dt>
249 <dd> 318 <dd>
250 source to be parsed (string) 319 source to be parsed (string)
251 </dd><dt><i>module</i></dt> 320 </dd>
321 <dt><i>module</i></dt>
252 <dd> 322 <dd>
253 name of the module (string) 323 name of the module (string)
254 </dd><dt><i>filename</i></dt> 324 </dd>
325 <dt><i>filename</i></dt>
255 <dd> 326 <dd>
256 file name (string) 327 file name (string)
257 </dd> 328 </dd>
258 </dl><a NAME="Visitor.__visit" ID="Visitor.__visit"></a> 329 </dl>
330 <a NAME="Visitor.__visit" ID="Visitor.__visit"></a>
259 <h4>Visitor.__visit</h4> 331 <h4>Visitor.__visit</h4>
260 <b>__visit</b>(<i>root</i>) 332 <b>__visit</b>(<i>root</i>)
333
261 <p> 334 <p>
262 Private method implementing the visit logic delegating to interesting 335 Private method implementing the visit logic delegating to interesting
263 methods. 336 methods.
264 </p><dl> 337 </p>
338 <dl>
339
265 <dt><i>root</i></dt> 340 <dt><i>root</i></dt>
266 <dd> 341 <dd>
267 root node to visit 342 root node to visit
268 </dd> 343 </dd>
269 </dl><a NAME="Visitor.call" ID="Visitor.call"></a> 344 </dl>
345 <a NAME="Visitor.call" ID="Visitor.call"></a>
270 <h4>Visitor.call</h4> 346 <h4>Visitor.call</h4>
271 <b>call</b>(<i></i>) 347 <b>call</b>(<i></i>)
348
272 <a NAME="Visitor.parse" ID="Visitor.parse"></a> 349 <a NAME="Visitor.parse" ID="Visitor.parse"></a>
273 <h4>Visitor.parse</h4> 350 <h4>Visitor.parse</h4>
274 <b>parse</b>(<i></i>) 351 <b>parse</b>(<i></i>)
352
275 <p> 353 <p>
276 Public method to parse the source. 354 Public method to parse the source.
277 </p><dl> 355 </p>
356 <dl>
278 <dt>Returns:</dt> 357 <dt>Returns:</dt>
279 <dd> 358 <dd>
280 dictionary containing the parsed information 359 dictionary containing the parsed information
281 </dd> 360 </dd>
282 </dl><a NAME="Visitor.visit_const" ID="Visitor.visit_const"></a> 361 </dl>
362 <a NAME="Visitor.visit_const" ID="Visitor.visit_const"></a>
283 <h4>Visitor.visit_const</h4> 363 <h4>Visitor.visit_const</h4>
284 <b>visit_const</b>(<i>node</i>) 364 <b>visit_const</b>(<i>node</i>)
365
285 <p> 366 <p>
286 Public method to treat a constant node. 367 Public method to treat a constant node.
287 </p><dl> 368 </p>
369 <dl>
370
288 <dt><i>node</i></dt> 371 <dt><i>node</i></dt>
289 <dd> 372 <dd>
290 reference to the node (jasy.script.parse.Node.Node) 373 reference to the node (jasy.script.parse.Node.Node)
291 </dd> 374 </dd>
292 </dl><a NAME="Visitor.visit_function" ID="Visitor.visit_function"></a> 375 </dl>
376 <a NAME="Visitor.visit_function" ID="Visitor.visit_function"></a>
293 <h4>Visitor.visit_function</h4> 377 <h4>Visitor.visit_function</h4>
294 <b>visit_function</b>(<i>node</i>) 378 <b>visit_function</b>(<i>node</i>)
379
295 <p> 380 <p>
296 Public method to treat a function node. 381 Public method to treat a function node.
297 </p><dl> 382 </p>
383 <dl>
384
298 <dt><i>node</i></dt> 385 <dt><i>node</i></dt>
299 <dd> 386 <dd>
300 reference to the node (jasy.script.parse.Node.Node) 387 reference to the node (jasy.script.parse.Node.Node)
301 </dd> 388 </dd>
302 </dl><a NAME="Visitor.visit_noop" ID="Visitor.visit_noop"></a> 389 </dl>
390 <a NAME="Visitor.visit_noop" ID="Visitor.visit_noop"></a>
303 <h4>Visitor.visit_noop</h4> 391 <h4>Visitor.visit_noop</h4>
304 <b>visit_noop</b>(<i>node</i>) 392 <b>visit_noop</b>(<i>node</i>)
393
305 <p> 394 <p>
306 Public method to ignore the given node. 395 Public method to ignore the given node.
307 </p><dl> 396 </p>
397 <dl>
398
308 <dt><i>node</i></dt> 399 <dt><i>node</i></dt>
309 <dd> 400 <dd>
310 reference to the node (jasy.script.parse.Node.Node) 401 reference to the node (jasy.script.parse.Node.Node)
311 </dd> 402 </dd>
312 </dl><a NAME="Visitor.visit_property_init" ID="Visitor.visit_property_init"></a> 403 </dl>
404 <a NAME="Visitor.visit_property_init" ID="Visitor.visit_property_init"></a>
313 <h4>Visitor.visit_property_init</h4> 405 <h4>Visitor.visit_property_init</h4>
314 <b>visit_property_init</b>(<i>node</i>) 406 <b>visit_property_init</b>(<i>node</i>)
407
315 <p> 408 <p>
316 Public method to treat a property_init node. 409 Public method to treat a property_init node.
317 </p><dl> 410 </p>
411 <dl>
412
318 <dt><i>node</i></dt> 413 <dt><i>node</i></dt>
319 <dd> 414 <dd>
320 reference to the node (jasy.script.parse.Node.Node) 415 reference to the node (jasy.script.parse.Node.Node)
321 </dd> 416 </dd>
322 </dl><a NAME="Visitor.visit_var" ID="Visitor.visit_var"></a> 417 </dl>
418 <a NAME="Visitor.visit_var" ID="Visitor.visit_var"></a>
323 <h4>Visitor.visit_var</h4> 419 <h4>Visitor.visit_var</h4>
324 <b>visit_var</b>(<i>node</i>) 420 <b>visit_var</b>(<i>node</i>)
421
325 <p> 422 <p>
326 Public method to treat a variable node. 423 Public method to treat a variable node.
327 </p><dl> 424 </p>
425 <dl>
426
328 <dt><i>node</i></dt> 427 <dt><i>node</i></dt>
329 <dd> 428 <dd>
330 reference to the node (jasy.script.parse.Node.Node) 429 reference to the node (jasy.script.parse.Node.Node)
331 </dd> 430 </dd>
332 </dl> 431 </dl>
333 <div align="right"><a href="#top">Up</a></div> 432 <div align="right"><a href="#top">Up</a></div>
334 <hr /><hr /> 433 <hr />
434 <hr />
335 <a NAME="readmodule_ex" ID="readmodule_ex"></a> 435 <a NAME="readmodule_ex" ID="readmodule_ex"></a>
336 <h2>readmodule_ex</h2> 436 <h2>readmodule_ex</h2>
337 <b>readmodule_ex</b>(<i>module, path=None</i>) 437 <b>readmodule_ex</b>(<i>module, path=None</i>)
438
338 <p> 439 <p>
339 Read a JavaScript file and return a dictionary of functions and variables. 440 Read a JavaScript file and return a dictionary of functions and variables.
340 </p><dl> 441 </p>
442 <dl>
443
341 <dt><i>module</i></dt> 444 <dt><i>module</i></dt>
342 <dd> 445 <dd>
343 name of the JavaScript file (string) 446 name of the JavaScript file (string)
344 </dd><dt><i>path</i></dt> 447 </dd>
448 <dt><i>path</i></dt>
345 <dd> 449 <dd>
346 path the file should be searched in (list of strings) 450 path the file should be searched in (list of strings)
347 </dd> 451 </dd>
348 </dl><dl> 452 </dl>
453 <dl>
349 <dt>Returns:</dt> 454 <dt>Returns:</dt>
350 <dd> 455 <dd>
351 the resulting dictionary 456 the resulting dictionary
352 </dd> 457 </dd>
353 </dl> 458 </dl>

eric ide

mercurial