Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html
eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8444
- 88b242eba71b
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing an interface to add different languages to do a syntax | |
| 27 check. | |
| 28 </p> | |
| 29 <h3>Global Attributes</h3> | |
| 30 | |
| 31 <table> | |
| 32 <tr><td>None</td></tr> | |
| 33 </table> | |
| 34 <h3>Classes</h3> | |
| 35 | |
| 36 <table> | |
| 37 | |
| 38 <tr> | |
| 39 <td><a href="#SyntaxCheckService">SyntaxCheckService</a></td> | |
| 40 <td>Implement the syntax check service.</td> | |
| 41 </tr> | |
| 42 </table> | |
| 43 <h3>Functions</h3> | |
| 44 | |
| 45 <table> | |
| 46 <tr><td>None</td></tr> | |
| 47 </table> | |
| 48 <hr /> | |
| 49 <hr /> | |
| 50 <a NAME="SyntaxCheckService" ID="SyntaxCheckService"></a> | |
| 51 <h2>SyntaxCheckService</h2> | |
| 52 | |
| 53 <p> | |
| 54 Implement the syntax check service. | |
| 55 </p> | |
| 56 <p> | |
| 57 Plugins can add other languages to the syntax check by calling addLanguage | |
| 58 and support of an extra checker module on the client side which has to | |
| 59 connect directly to the background service. | |
| 60 </p> | |
| 61 <h3>Signals</h3> | |
| 62 <dl> | |
| 63 | |
| 64 <dt>batchFinished()</dt> | |
| 65 <dd> | |
| 66 emitted when a syntax check batch is done | |
| 67 </dd> | |
| 68 <dt>error(str, str)</dt> | |
| 69 <dd> | |
| 70 emitted in case of an error | |
| 71 </dd> | |
| 72 <dt>syntaxChecked(str, dict)</dt> | |
| 73 <dd> | |
| 74 emitted when the syntax check was done for | |
| 75 one file | |
| 76 </dd> | |
| 77 </dl> | |
| 78 <h3>Derived from</h3> | |
| 79 QObject | |
| 80 <h3>Class Attributes</h3> | |
| 81 | |
| 82 <table> | |
| 83 <tr><td>None</td></tr> | |
| 84 </table> | |
| 85 <h3>Class Methods</h3> | |
| 86 | |
| 87 <table> | |
| 88 <tr><td>None</td></tr> | |
| 89 </table> | |
| 90 <h3>Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 | |
| 94 <tr> | |
| 95 <td><a href="#SyntaxCheckService.__init__">SyntaxCheckService</a></td> | |
| 96 <td>Constructor</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#SyntaxCheckService.__determineLanguage">__determineLanguage</a></td> | |
| 100 <td>Private methode to determine the language of the file.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#SyntaxCheckService.__serviceError">__serviceError</a></td> | |
| 104 <td>Private slot handling service errors.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#SyntaxCheckService.addLanguage">addLanguage</a></td> | |
| 108 <td>Public method to register a new language to the supported languages.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#SyntaxCheckService.batchJobDone">batchJobDone</a></td> | |
| 112 <td>Public slot handling the completion of a batch job.</td> | |
| 113 </tr> | |
| 114 <tr> | |
| 115 <td><a href="#SyntaxCheckService.cancelSyntaxBatchCheck">cancelSyntaxBatchCheck</a></td> | |
| 116 <td>Public method to cancel all batch jobs.</td> | |
| 117 </tr> | |
| 118 <tr> | |
| 119 <td><a href="#SyntaxCheckService.getExtensions">getExtensions</a></td> | |
| 120 <td>Public method to return all supported file extensions for the syntax checker dialog.</td> | |
| 121 </tr> | |
| 122 <tr> | |
| 123 <td><a href="#SyntaxCheckService.getLanguages">getLanguages</a></td> | |
| 124 <td>Public method to return the supported language names.</td> | |
| 125 </tr> | |
| 126 <tr> | |
| 127 <td><a href="#SyntaxCheckService.removeLanguage">removeLanguage</a></td> | |
| 128 <td>Public method to remove the language from syntax check.</td> | |
| 129 </tr> | |
| 130 <tr> | |
| 131 <td><a href="#SyntaxCheckService.serviceErrorJSON">serviceErrorJSON</a></td> | |
| 132 <td>Public method handling service errors for JSON.</td> | |
| 133 </tr> | |
| 134 <tr> | |
| 135 <td><a href="#SyntaxCheckService.serviceErrorJavaScript">serviceErrorJavaScript</a></td> | |
| 136 <td>Public method handling service errors for JavaScript.</td> | |
| 137 </tr> | |
| 138 <tr> | |
| 139 <td><a href="#SyntaxCheckService.serviceErrorPy3">serviceErrorPy3</a></td> | |
| 140 <td>Public method handling service errors for Python 3.</td> | |
| 141 </tr> | |
| 142 <tr> | |
| 143 <td><a href="#SyntaxCheckService.serviceErrorTOML">serviceErrorTOML</a></td> | |
| 144 <td>Public method handling service errors for TOML.</td> | |
| 145 </tr> | |
| 146 <tr> | |
| 147 <td><a href="#SyntaxCheckService.serviceErrorYAML">serviceErrorYAML</a></td> | |
| 148 <td>Public method handling service errors for YAML.</td> | |
| 149 </tr> | |
| 150 <tr> | |
| 151 <td><a href="#SyntaxCheckService.syntaxBatchCheck">syntaxBatchCheck</a></td> | |
| 152 <td>Public method to prepare a syntax check on multiple source files.</td> | |
| 153 </tr> | |
| 154 <tr> | |
| 155 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td> | |
| 156 <td>Public method to prepare a syntax check of one source file.</td> | |
| 157 </tr> | |
| 158 </table> | |
| 159 <h3>Static Methods</h3> | |
| 160 | |
| 161 <table> | |
| 162 <tr><td>None</td></tr> | |
| 163 </table> | |
| 164 | |
| 165 <a NAME="SyntaxCheckService.__init__" ID="SyntaxCheckService.__init__"></a> | |
| 166 <h4>SyntaxCheckService (Constructor)</h4> | |
| 167 <b>SyntaxCheckService</b>(<i></i>) | |
| 168 | |
| 169 <p> | |
| 170 Constructor | |
| 171 </p> | |
| 172 <a NAME="SyntaxCheckService.__determineLanguage" ID="SyntaxCheckService.__determineLanguage"></a> | |
| 173 <h4>SyntaxCheckService.__determineLanguage</h4> | |
| 174 <b>__determineLanguage</b>(<i>filename, source</i>) | |
| 175 | |
| 176 <p> | |
| 177 Private methode to determine the language of the file. | |
| 178 </p> | |
| 179 <dl> | |
| 180 | |
| 181 <dt><i>filename</i></dt> | |
| 182 <dd> | |
| 183 of the sourcefile (str) | |
| 184 </dd> | |
| 185 <dt><i>source</i></dt> | |
| 186 <dd> | |
| 187 code of the file (str) | |
| 188 </dd> | |
| 189 </dl> | |
| 190 <dl> | |
| 191 <dt>Return:</dt> | |
| 192 <dd> | |
| 193 language of the file or None if not found (str or None) | |
| 194 </dd> | |
| 195 </dl> | |
| 196 <a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a> | |
| 197 <h4>SyntaxCheckService.__serviceError</h4> | |
| 198 <b>__serviceError</b>(<i>fn, msg</i>) | |
| 199 | |
| 200 <p> | |
| 201 Private slot handling service errors. | |
| 202 </p> | |
| 203 <dl> | |
| 204 | |
| 205 <dt><i>fn</i></dt> | |
| 206 <dd> | |
| 207 file name (string) | |
| 208 </dd> | |
| 209 <dt><i>msg</i></dt> | |
| 210 <dd> | |
| 211 message text (string) | |
| 212 </dd> | |
| 213 </dl> | |
| 214 <a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a> | |
| 215 <h4>SyntaxCheckService.addLanguage</h4> | |
| 216 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>) | |
| 217 | |
| 218 <p> | |
| 219 Public method to register a new language to the supported languages. | |
| 220 </p> | |
| 221 <dl> | |
| 222 | |
| 223 <dt><i>lang</i></dt> | |
| 224 <dd> | |
| 225 new language to check syntax (str) | |
| 226 </dd> | |
| 227 <dt><i>env</i></dt> | |
| 228 <dd> | |
| 229 the environment in which the checker is implemented (str) | |
| 230 </dd> | |
| 231 <dt><i>path</i></dt> | |
| 232 <dd> | |
| 233 full path to the module (str) | |
| 234 </dd> | |
| 235 <dt><i>module</i></dt> | |
| 236 <dd> | |
| 237 name to import (str) | |
| 238 </dd> | |
| 239 <dt><i>getArgs</i></dt> | |
| 240 <dd> | |
| 241 function to collect the required arguments to call the | |
| 242 syntax checker on client side (function) | |
| 243 </dd> | |
| 244 <dt><i>getExt</i></dt> | |
| 245 <dd> | |
| 246 function that returns the supported file extensions of | |
| 247 the syntax checker (function) | |
| 248 </dd> | |
| 249 <dt><i>callback</i></dt> | |
| 250 <dd> | |
| 251 function on service response (function) | |
| 252 </dd> | |
| 253 <dt><i>onError</i></dt> | |
| 254 <dd> | |
| 255 callback function if client or service isn't available | |
| 256 (function) | |
| 257 </dd> | |
| 258 </dl> | |
| 259 <a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a> | |
| 260 <h4>SyntaxCheckService.batchJobDone</h4> | |
| 261 <b>batchJobDone</b>(<i>fx, lang</i>) | |
| 262 | |
| 263 <p> | |
| 264 Public slot handling the completion of a batch job. | |
| 265 </p> | |
| 266 <dl> | |
| 267 | |
| 268 <dt><i>fx</i></dt> | |
| 269 <dd> | |
| 270 service name (string) | |
| 271 </dd> | |
| 272 <dt><i>lang</i></dt> | |
| 273 <dd> | |
| 274 language (string) | |
| 275 </dd> | |
| 276 </dl> | |
| 277 <a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a> | |
| 278 <h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4> | |
| 279 <b>cancelSyntaxBatchCheck</b>(<i></i>) | |
| 280 | |
| 281 <p> | |
| 282 Public method to cancel all batch jobs. | |
| 283 </p> | |
| 284 <a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a> | |
| 285 <h4>SyntaxCheckService.getExtensions</h4> | |
| 286 <b>getExtensions</b>(<i></i>) | |
| 287 | |
| 288 <p> | |
| 289 Public method to return all supported file extensions for the | |
| 290 syntax checker dialog. | |
| 291 </p> | |
| 292 <dl> | |
| 293 <dt>Return:</dt> | |
| 294 <dd> | |
| 295 set of all supported file extensions (set of str) | |
| 296 </dd> | |
| 297 </dl> | |
| 298 <a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a> | |
| 299 <h4>SyntaxCheckService.getLanguages</h4> | |
| 300 <b>getLanguages</b>(<i></i>) | |
| 301 | |
| 302 <p> | |
| 303 Public method to return the supported language names. | |
| 304 </p> | |
| 305 <dl> | |
| 306 <dt>Return:</dt> | |
| 307 <dd> | |
| 308 list of languanges supported (list of str) | |
| 309 </dd> | |
| 310 </dl> | |
| 311 <a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a> | |
| 312 <h4>SyntaxCheckService.removeLanguage</h4> | |
| 313 <b>removeLanguage</b>(<i>lang</i>) | |
| 314 | |
| 315 <p> | |
| 316 Public method to remove the language from syntax check. | |
| 317 </p> | |
| 318 <dl> | |
| 319 | |
| 320 <dt><i>lang</i></dt> | |
| 321 <dd> | |
| 322 language to remove (str) | |
| 323 </dd> | |
| 324 </dl> | |
| 325 <a NAME="SyntaxCheckService.serviceErrorJSON" ID="SyntaxCheckService.serviceErrorJSON"></a> | |
| 326 <h4>SyntaxCheckService.serviceErrorJSON</h4> | |
| 327 <b>serviceErrorJSON</b>(<i>fx, lang, fn, msg</i>) | |
| 328 | |
| 329 <p> | |
| 330 Public method handling service errors for JSON. | |
| 331 </p> | |
| 332 <dl> | |
| 333 | |
| 334 <dt><i>fx</i></dt> | |
| 335 <dd> | |
| 336 service name (string) | |
| 337 </dd> | |
| 338 <dt><i>lang</i></dt> | |
| 339 <dd> | |
| 340 language (string) | |
| 341 </dd> | |
| 342 <dt><i>fn</i></dt> | |
| 343 <dd> | |
| 344 file name (string) | |
| 345 </dd> | |
| 346 <dt><i>msg</i></dt> | |
| 347 <dd> | |
| 348 message text (string) | |
| 349 </dd> | |
| 350 </dl> | |
| 351 <a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a> | |
| 352 <h4>SyntaxCheckService.serviceErrorJavaScript</h4> | |
| 353 <b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>) | |
| 354 | |
| 355 <p> | |
| 356 Public method handling service errors for JavaScript. | |
| 357 </p> | |
| 358 <dl> | |
| 359 | |
| 360 <dt><i>fx</i></dt> | |
| 361 <dd> | |
| 362 service name (string) | |
| 363 </dd> | |
| 364 <dt><i>lang</i></dt> | |
| 365 <dd> | |
| 366 language (string) | |
| 367 </dd> | |
| 368 <dt><i>fn</i></dt> | |
| 369 <dd> | |
| 370 file name (string) | |
| 371 </dd> | |
| 372 <dt><i>msg</i></dt> | |
| 373 <dd> | |
| 374 message text (string) | |
| 375 </dd> | |
| 376 </dl> | |
| 377 <a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a> | |
| 378 <h4>SyntaxCheckService.serviceErrorPy3</h4> | |
| 379 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) | |
| 380 | |
| 381 <p> | |
| 382 Public method handling service errors for Python 3. | |
| 383 </p> | |
| 384 <dl> | |
| 385 | |
| 386 <dt><i>fx</i></dt> | |
| 387 <dd> | |
| 388 service name (string) | |
| 389 </dd> | |
| 390 <dt><i>lang</i></dt> | |
| 391 <dd> | |
| 392 language (string) | |
| 393 </dd> | |
| 394 <dt><i>fn</i></dt> | |
| 395 <dd> | |
| 396 file name (string) | |
| 397 </dd> | |
| 398 <dt><i>msg</i></dt> | |
| 399 <dd> | |
| 400 message text (string) | |
| 401 </dd> | |
| 402 </dl> | |
| 403 <a NAME="SyntaxCheckService.serviceErrorTOML" ID="SyntaxCheckService.serviceErrorTOML"></a> | |
| 404 <h4>SyntaxCheckService.serviceErrorTOML</h4> | |
| 405 <b>serviceErrorTOML</b>(<i>fx, lang, fn, msg</i>) | |
| 406 | |
| 407 <p> | |
| 408 Public method handling service errors for TOML. | |
| 409 </p> | |
| 410 <dl> | |
| 411 | |
| 412 <dt><i>fx</i></dt> | |
| 413 <dd> | |
| 414 service name (string) | |
| 415 </dd> | |
| 416 <dt><i>lang</i></dt> | |
| 417 <dd> | |
| 418 language (string) | |
| 419 </dd> | |
| 420 <dt><i>fn</i></dt> | |
| 421 <dd> | |
| 422 file name (string) | |
| 423 </dd> | |
| 424 <dt><i>msg</i></dt> | |
| 425 <dd> | |
| 426 message text (string) | |
| 427 </dd> | |
| 428 </dl> | |
| 429 <a NAME="SyntaxCheckService.serviceErrorYAML" ID="SyntaxCheckService.serviceErrorYAML"></a> | |
| 430 <h4>SyntaxCheckService.serviceErrorYAML</h4> | |
| 431 <b>serviceErrorYAML</b>(<i>fx, lang, fn, msg</i>) | |
| 432 | |
| 433 <p> | |
| 434 Public method handling service errors for YAML. | |
| 435 </p> | |
| 436 <dl> | |
| 437 | |
| 438 <dt><i>fx</i></dt> | |
| 439 <dd> | |
| 440 service name (string) | |
| 441 </dd> | |
| 442 <dt><i>lang</i></dt> | |
| 443 <dd> | |
| 444 language (string) | |
| 445 </dd> | |
| 446 <dt><i>fn</i></dt> | |
| 447 <dd> | |
| 448 file name (string) | |
| 449 </dd> | |
| 450 <dt><i>msg</i></dt> | |
| 451 <dd> | |
| 452 message text (string) | |
| 453 </dd> | |
| 454 </dl> | |
| 455 <a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a> | |
| 456 <h4>SyntaxCheckService.syntaxBatchCheck</h4> | |
| 457 <b>syntaxBatchCheck</b>(<i>argumentsList</i>) | |
| 458 | |
| 459 <p> | |
| 460 Public method to prepare a syntax check on multiple source files. | |
| 461 </p> | |
| 462 <dl> | |
| 463 | |
| 464 <dt><i>argumentsList</i></dt> | |
| 465 <dd> | |
| 466 list of arguments tuples with each tuple | |
| 467 containing filename and source (string, string) | |
| 468 </dd> | |
| 469 </dl> | |
| 470 <a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a> | |
| 471 <h4>SyntaxCheckService.syntaxCheck</h4> | |
| 472 <b>syntaxCheck</b>(<i>lang, filename, source</i>) | |
| 473 | |
| 474 <p> | |
| 475 Public method to prepare a syntax check of one source file. | |
| 476 </p> | |
| 477 <dl> | |
| 478 | |
| 479 <dt><i>lang</i></dt> | |
| 480 <dd> | |
| 481 language of the file or None to determine by internal | |
| 482 algorithm (str or None) | |
| 483 </dd> | |
| 484 <dt><i>filename</i></dt> | |
| 485 <dd> | |
| 486 source filename (string) | |
| 487 </dd> | |
| 488 <dt><i>source</i></dt> | |
| 489 <dd> | |
| 490 string containing the code to check (string) | |
| 491 </dd> | |
| 492 </dl> | |
| 493 <div align="right"><a href="#top">Up</a></div> | |
| 494 <hr /> | |
| 495 </body></html> |
