Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html

src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html

branch
eric7
changeset 10479
856476537696
parent 10341
3fdffd9cc21d
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService</h1> 9 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService</h1>
10
11 <p> 10 <p>
12 Module implementing an interface to add different languages to do a syntax 11 Module implementing an interface to add different languages to do a syntax
13 check. 12 check.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16
17 <table> 16 <table>
18 <tr><td>None</td></tr> 17 <tr><td>None</td></tr>
19 </table> 18 </table>
19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#SyntaxCheckService">SyntaxCheckService</a></td> 23 <td><a href="#SyntaxCheckService">SyntaxCheckService</a></td>
26 <td>Implement the syntax check service.</td> 24 <td>Implement the syntax check service.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30
31 <table> 29 <table>
32 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
33 </table> 31 </table>
32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="SyntaxCheckService" ID="SyntaxCheckService"></a> 35 <a NAME="SyntaxCheckService" ID="SyntaxCheckService"></a>
37 <h2>SyntaxCheckService</h2> 36 <h2>SyntaxCheckService</h2>
38
39 <p> 37 <p>
40 Implement the syntax check service. 38 Implement the syntax check service.
41 </p> 39 </p>
42 <p> 40 <p>
43 Plugins can add other languages to the syntax check by calling addLanguage 41 Plugins can add other languages to the syntax check by calling addLanguage
44 and support of an extra checker module on the client side which has to 42 and support of an extra checker module on the client side which has to
45 connect directly to the background service. 43 connect directly to the background service.
46 </p> 44 </p>
45
47 <h3>Signals</h3> 46 <h3>Signals</h3>
48 <dl> 47 <dl>
49 48
50 <dt>batchFinished()</dt> 49 <dt>batchFinished()</dt>
51 <dd> 50 <dd>
62 </dd> 61 </dd>
63 </dl> 62 </dl>
64 <h3>Derived from</h3> 63 <h3>Derived from</h3>
65 QObject 64 QObject
66 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
67
68 <table> 66 <table>
69 <tr><td>None</td></tr> 67 <tr><td>None</td></tr>
70 </table> 68 </table>
69
71 <h3>Class Methods</h3> 70 <h3>Class Methods</h3>
72
73 <table> 71 <table>
74 <tr><td>None</td></tr> 72 <tr><td>None</td></tr>
75 </table> 73 </table>
74
76 <h3>Methods</h3> 75 <h3>Methods</h3>
77 76 <table>
78 <table>
79
80 <tr> 77 <tr>
81 <td><a href="#SyntaxCheckService.__init__">SyntaxCheckService</a></td> 78 <td><a href="#SyntaxCheckService.__init__">SyntaxCheckService</a></td>
82 <td>Constructor</td> 79 <td>Constructor</td>
83 </tr> 80 </tr>
84 <tr> 81 <tr>
140 <tr> 137 <tr>
141 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td> 138 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td>
142 <td>Public method to prepare a syntax check of one source file.</td> 139 <td>Public method to prepare a syntax check of one source file.</td>
143 </tr> 140 </tr>
144 </table> 141 </table>
142
145 <h3>Static Methods</h3> 143 <h3>Static Methods</h3>
146
147 <table> 144 <table>
148 <tr><td>None</td></tr> 145 <tr><td>None</td></tr>
149 </table> 146 </table>
147
150 148
151 <a NAME="SyntaxCheckService.__init__" ID="SyntaxCheckService.__init__"></a> 149 <a NAME="SyntaxCheckService.__init__" ID="SyntaxCheckService.__init__"></a>
152 <h4>SyntaxCheckService (Constructor)</h4> 150 <h4>SyntaxCheckService (Constructor)</h4>
153 <b>SyntaxCheckService</b>(<i></i>) 151 <b>SyntaxCheckService</b>(<i></i>)
154
155 <p> 152 <p>
156 Constructor 153 Constructor
157 </p> 154 </p>
155
158 <a NAME="SyntaxCheckService.__determineLanguage" ID="SyntaxCheckService.__determineLanguage"></a> 156 <a NAME="SyntaxCheckService.__determineLanguage" ID="SyntaxCheckService.__determineLanguage"></a>
159 <h4>SyntaxCheckService.__determineLanguage</h4> 157 <h4>SyntaxCheckService.__determineLanguage</h4>
160 <b>__determineLanguage</b>(<i>filename, source</i>) 158 <b>__determineLanguage</b>(<i>filename, source</i>)
161
162 <p> 159 <p>
163 Private method to determine the language of the file. 160 Private method to determine the language of the file.
164 </p> 161 </p>
162
165 <dl> 163 <dl>
166 164
167 <dt><i>filename</i> (str)</dt> 165 <dt><i>filename</i> (str)</dt>
168 <dd> 166 <dd>
169 of the sourcefile 167 of the sourcefile
186 </dd> 184 </dd>
187 </dl> 185 </dl>
188 <a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a> 186 <a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a>
189 <h4>SyntaxCheckService.__serviceError</h4> 187 <h4>SyntaxCheckService.__serviceError</h4>
190 <b>__serviceError</b>(<i>fn, msg</i>) 188 <b>__serviceError</b>(<i>fn, msg</i>)
191
192 <p> 189 <p>
193 Private slot handling service errors. 190 Private slot handling service errors.
194 </p> 191 </p>
192
195 <dl> 193 <dl>
196 194
197 <dt><i>fn</i> (str)</dt> 195 <dt><i>fn</i> (str)</dt>
198 <dd> 196 <dd>
199 file name 197 file name
204 </dd> 202 </dd>
205 </dl> 203 </dl>
206 <a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a> 204 <a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a>
207 <h4>SyntaxCheckService.addLanguage</h4> 205 <h4>SyntaxCheckService.addLanguage</h4>
208 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>) 206 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>)
209
210 <p> 207 <p>
211 Public method to register a new language to the supported languages. 208 Public method to register a new language to the supported languages.
212 </p> 209 </p>
210
213 <dl> 211 <dl>
214 212
215 <dt><i>lang</i> (str)</dt> 213 <dt><i>lang</i> (str)</dt>
216 <dd> 214 <dd>
217 new language to check syntax 215 new language to check syntax
248 </dd> 246 </dd>
249 </dl> 247 </dl>
250 <a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a> 248 <a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a>
251 <h4>SyntaxCheckService.batchJobDone</h4> 249 <h4>SyntaxCheckService.batchJobDone</h4>
252 <b>batchJobDone</b>(<i>fx, lang</i>) 250 <b>batchJobDone</b>(<i>fx, lang</i>)
253
254 <p> 251 <p>
255 Public slot handling the completion of a batch job. 252 Public slot handling the completion of a batch job.
256 </p> 253 </p>
254
257 <dl> 255 <dl>
258 256
259 <dt><i>fx</i> (str)</dt> 257 <dt><i>fx</i> (str)</dt>
260 <dd> 258 <dd>
261 service name 259 service name
266 </dd> 264 </dd>
267 </dl> 265 </dl>
268 <a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a> 266 <a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a>
269 <h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4> 267 <h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4>
270 <b>cancelSyntaxBatchCheck</b>(<i></i>) 268 <b>cancelSyntaxBatchCheck</b>(<i></i>)
271
272 <p> 269 <p>
273 Public method to cancel all batch jobs. 270 Public method to cancel all batch jobs.
274 </p> 271 </p>
272
275 <a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a> 273 <a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a>
276 <h4>SyntaxCheckService.getExtensions</h4> 274 <h4>SyntaxCheckService.getExtensions</h4>
277 <b>getExtensions</b>(<i></i>) 275 <b>getExtensions</b>(<i></i>)
278
279 <p> 276 <p>
280 Public method to return all supported file extensions for the 277 Public method to return all supported file extensions for the
281 syntax checker dialog. 278 syntax checker dialog.
282 </p> 279 </p>
280
283 <dl> 281 <dl>
284 <dt>Return:</dt> 282 <dt>Return:</dt>
285 <dd> 283 <dd>
286 set of all supported file extensions 284 set of all supported file extensions
287 </dd> 285 </dd>
293 </dd> 291 </dd>
294 </dl> 292 </dl>
295 <a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a> 293 <a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a>
296 <h4>SyntaxCheckService.getLanguages</h4> 294 <h4>SyntaxCheckService.getLanguages</h4>
297 <b>getLanguages</b>(<i></i>) 295 <b>getLanguages</b>(<i></i>)
298
299 <p> 296 <p>
300 Public method to return the supported language names. 297 Public method to return the supported language names.
301 </p> 298 </p>
299
302 <dl> 300 <dl>
303 <dt>Return:</dt> 301 <dt>Return:</dt>
304 <dd> 302 <dd>
305 list of languanges supported 303 list of languanges supported
306 </dd> 304 </dd>
312 </dd> 310 </dd>
313 </dl> 311 </dl>
314 <a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a> 312 <a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a>
315 <h4>SyntaxCheckService.removeLanguage</h4> 313 <h4>SyntaxCheckService.removeLanguage</h4>
316 <b>removeLanguage</b>(<i>lang</i>) 314 <b>removeLanguage</b>(<i>lang</i>)
317
318 <p> 315 <p>
319 Public method to remove the language from syntax check. 316 Public method to remove the language from syntax check.
320 </p> 317 </p>
318
321 <dl> 319 <dl>
322 320
323 <dt><i>lang</i> (str)</dt> 321 <dt><i>lang</i> (str)</dt>
324 <dd> 322 <dd>
325 language to remove 323 language to remove
326 </dd> 324 </dd>
327 </dl> 325 </dl>
328 <a NAME="SyntaxCheckService.serviceErrorJSON" ID="SyntaxCheckService.serviceErrorJSON"></a> 326 <a NAME="SyntaxCheckService.serviceErrorJSON" ID="SyntaxCheckService.serviceErrorJSON"></a>
329 <h4>SyntaxCheckService.serviceErrorJSON</h4> 327 <h4>SyntaxCheckService.serviceErrorJSON</h4>
330 <b>serviceErrorJSON</b>(<i>fx, lang, fn, msg</i>) 328 <b>serviceErrorJSON</b>(<i>fx, lang, fn, msg</i>)
331
332 <p> 329 <p>
333 Public method handling service errors for JSON. 330 Public method handling service errors for JSON.
334 </p> 331 </p>
332
335 <dl> 333 <dl>
336 334
337 <dt><i>fx</i> (str)</dt> 335 <dt><i>fx</i> (str)</dt>
338 <dd> 336 <dd>
339 service name 337 service name
352 </dd> 350 </dd>
353 </dl> 351 </dl>
354 <a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a> 352 <a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a>
355 <h4>SyntaxCheckService.serviceErrorJavaScript</h4> 353 <h4>SyntaxCheckService.serviceErrorJavaScript</h4>
356 <b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>) 354 <b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>)
357
358 <p> 355 <p>
359 Public method handling service errors for JavaScript. 356 Public method handling service errors for JavaScript.
360 </p> 357 </p>
358
361 <dl> 359 <dl>
362 360
363 <dt><i>fx</i> (str)</dt> 361 <dt><i>fx</i> (str)</dt>
364 <dd> 362 <dd>
365 service name 363 service name
378 </dd> 376 </dd>
379 </dl> 377 </dl>
380 <a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a> 378 <a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a>
381 <h4>SyntaxCheckService.serviceErrorPy3</h4> 379 <h4>SyntaxCheckService.serviceErrorPy3</h4>
382 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) 380 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
383
384 <p> 381 <p>
385 Public method handling service errors for Python 3. 382 Public method handling service errors for Python 3.
386 </p> 383 </p>
384
387 <dl> 385 <dl>
388 386
389 <dt><i>fx</i> (str)</dt> 387 <dt><i>fx</i> (str)</dt>
390 <dd> 388 <dd>
391 service name 389 service name
404 </dd> 402 </dd>
405 </dl> 403 </dl>
406 <a NAME="SyntaxCheckService.serviceErrorTOML" ID="SyntaxCheckService.serviceErrorTOML"></a> 404 <a NAME="SyntaxCheckService.serviceErrorTOML" ID="SyntaxCheckService.serviceErrorTOML"></a>
407 <h4>SyntaxCheckService.serviceErrorTOML</h4> 405 <h4>SyntaxCheckService.serviceErrorTOML</h4>
408 <b>serviceErrorTOML</b>(<i>fx, lang, fn, msg</i>) 406 <b>serviceErrorTOML</b>(<i>fx, lang, fn, msg</i>)
409
410 <p> 407 <p>
411 Public method handling service errors for TOML. 408 Public method handling service errors for TOML.
412 </p> 409 </p>
410
413 <dl> 411 <dl>
414 412
415 <dt><i>fx</i> (str)</dt> 413 <dt><i>fx</i> (str)</dt>
416 <dd> 414 <dd>
417 service name 415 service name
430 </dd> 428 </dd>
431 </dl> 429 </dl>
432 <a NAME="SyntaxCheckService.serviceErrorYAML" ID="SyntaxCheckService.serviceErrorYAML"></a> 430 <a NAME="SyntaxCheckService.serviceErrorYAML" ID="SyntaxCheckService.serviceErrorYAML"></a>
433 <h4>SyntaxCheckService.serviceErrorYAML</h4> 431 <h4>SyntaxCheckService.serviceErrorYAML</h4>
434 <b>serviceErrorYAML</b>(<i>fx, lang, fn, msg</i>) 432 <b>serviceErrorYAML</b>(<i>fx, lang, fn, msg</i>)
435
436 <p> 433 <p>
437 Public method handling service errors for YAML. 434 Public method handling service errors for YAML.
438 </p> 435 </p>
436
439 <dl> 437 <dl>
440 438
441 <dt><i>fx</i> (str)</dt> 439 <dt><i>fx</i> (str)</dt>
442 <dd> 440 <dd>
443 service name 441 service name
456 </dd> 454 </dd>
457 </dl> 455 </dl>
458 <a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a> 456 <a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a>
459 <h4>SyntaxCheckService.syntaxBatchCheck</h4> 457 <h4>SyntaxCheckService.syntaxBatchCheck</h4>
460 <b>syntaxBatchCheck</b>(<i>argumentsList</i>) 458 <b>syntaxBatchCheck</b>(<i>argumentsList</i>)
461
462 <p> 459 <p>
463 Public method to prepare a syntax check on multiple source files. 460 Public method to prepare a syntax check on multiple source files.
464 </p> 461 </p>
462
465 <dl> 463 <dl>
466 464
467 <dt><i>argumentsList</i> (list of tuples of (str, str))</dt> 465 <dt><i>argumentsList</i> (list of tuples of (str, str))</dt>
468 <dd> 466 <dd>
469 list of argument tuples with each tuple 467 list of argument tuples with each tuple
471 </dd> 469 </dd>
472 </dl> 470 </dl>
473 <a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a> 471 <a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a>
474 <h4>SyntaxCheckService.syntaxCheck</h4> 472 <h4>SyntaxCheckService.syntaxCheck</h4>
475 <b>syntaxCheck</b>(<i>lang, filename, source, *args</i>) 473 <b>syntaxCheck</b>(<i>lang, filename, source, *args</i>)
476
477 <p> 474 <p>
478 Public method to prepare a syntax check of one source file. 475 Public method to prepare a syntax check of one source file.
479 </p> 476 </p>
477
480 <dl> 478 <dl>
481 479
482 <dt><i>lang</i> (str or None)</dt> 480 <dt><i>lang</i> (str or None)</dt>
483 <dd> 481 <dd>
484 language of the file or None to determine by internal 482 language of the file or None to determine by internal

Mercurial Repository: eric

eric ide

mercurial