Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html
Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html
- changeset 4232
- 8349fd3f8802
- parent 3673
- e26d7d0c1088
- child 4503
- d68dcbe1deb3
equal
deleted
inserted
replaced
| 4231:0b38613388c9 | 4232:8349fd3f8802 |
|---|---|
| 48 Plugins can add other languages to the syntax check by calling addLanguage | 48 Plugins can add other languages to the syntax check by calling addLanguage |
| 49 and support of an extra checker module on the client side which has to | 49 and support of an extra checker module on the client side which has to |
| 50 connect directly to the background service. | 50 connect directly to the background service. |
| 51 </p><h3>Signals</h3> | 51 </p><h3>Signals</h3> |
| 52 <dl> | 52 <dl> |
| 53 <dt>syntaxChecked(str, dict)</dt> | 53 <dt>batchFinished()</dt> |
| 54 <dd> | 54 <dd> |
| 55 emited when the syntax check was done. | 55 emitted when a syntax check batch is done |
| 56 </dd><dt>syntaxChecked(str, dict)</dt> | |
| 57 <dd> | |
| 58 emitted when the syntax check was done for | |
| 59 one file | |
| 56 </dd> | 60 </dd> |
| 57 </dl> | 61 </dl> |
| 58 <h3>Derived from</h3> | 62 <h3>Derived from</h3> |
| 59 QObject | 63 QObject |
| 60 <h3>Class Attributes</h3> | 64 <h3>Class Attributes</h3> |
| 72 <td>Constructor</td> | 76 <td>Constructor</td> |
| 73 </tr><tr> | 77 </tr><tr> |
| 74 <td><a href="#SyntaxCheckService.__determineLanguage">__determineLanguage</a></td> | 78 <td><a href="#SyntaxCheckService.__determineLanguage">__determineLanguage</a></td> |
| 75 <td>Private methode to determine the language of the file.</td> | 79 <td>Private methode to determine the language of the file.</td> |
| 76 </tr><tr> | 80 </tr><tr> |
| 81 <td><a href="#SyntaxCheckService.__serviceError">__serviceError</a></td> | |
| 82 <td>Private slot handling service errors.</td> | |
| 83 </tr><tr> | |
| 77 <td><a href="#SyntaxCheckService.addLanguage">addLanguage</a></td> | 84 <td><a href="#SyntaxCheckService.addLanguage">addLanguage</a></td> |
| 78 <td>Public method to register a new language to the supported languages.</td> | 85 <td>Public method to register a new language to the supported languages.</td> |
| 79 </tr><tr> | 86 </tr><tr> |
| 87 <td><a href="#SyntaxCheckService.batchJobDone">batchJobDone</a></td> | |
| 88 <td>Public slot handling the completion of a batch job.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#SyntaxCheckService.cancelSyntaxBatchCheck">cancelSyntaxBatchCheck</a></td> | |
| 91 <td>Public method to cancel all batch jobs.</td> | |
| 92 </tr><tr> | |
| 80 <td><a href="#SyntaxCheckService.getExtensions">getExtensions</a></td> | 93 <td><a href="#SyntaxCheckService.getExtensions">getExtensions</a></td> |
| 81 <td>Public method to return all supported file extensions for the syntax checker dialog.</td> | 94 <td>Public method to return all supported file extensions for the syntax checker dialog.</td> |
| 82 </tr><tr> | 95 </tr><tr> |
| 83 <td><a href="#SyntaxCheckService.getLanguages">getLanguages</a></td> | 96 <td><a href="#SyntaxCheckService.getLanguages">getLanguages</a></td> |
| 84 <td>Public method to return the supported language names.</td> | 97 <td>Public method to return the supported language names.</td> |
| 85 </tr><tr> | 98 </tr><tr> |
| 86 <td><a href="#SyntaxCheckService.removeLanguage">removeLanguage</a></td> | 99 <td><a href="#SyntaxCheckService.removeLanguage">removeLanguage</a></td> |
| 87 <td>Public method to remove the language from syntax check.</td> | 100 <td>Public method to remove the language from syntax check.</td> |
| 88 </tr><tr> | 101 </tr><tr> |
| 102 <td><a href="#SyntaxCheckService.serviceErrorJavaScript">serviceErrorJavaScript</a></td> | |
| 103 <td>Public method handling service errors for JavaScript.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#SyntaxCheckService.serviceErrorPy2">serviceErrorPy2</a></td> | |
| 106 <td>Public method handling service errors for Python 2.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#SyntaxCheckService.serviceErrorPy3">serviceErrorPy3</a></td> | |
| 109 <td>Public method handling service errors for Python 2.</td> | |
| 110 </tr><tr> | |
| 111 <td><a href="#SyntaxCheckService.syntaxBatchCheck">syntaxBatchCheck</a></td> | |
| 112 <td>Public method to prepare a syntax check on multiple source files.</td> | |
| 113 </tr><tr> | |
| 89 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td> | 114 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td> |
| 90 <td>Public method to prepare to compile one Python source file to Python bytecode and to perform a pyflakes check.</td> | 115 <td>Public method to prepare a syntax check of one source file.</td> |
| 91 </tr> | 116 </tr> |
| 92 </table> | 117 </table> |
| 93 <h3>Static Methods</h3> | 118 <h3>Static Methods</h3> |
| 94 <table> | 119 <table> |
| 95 <tr><td>None</td></tr> | 120 <tr><td>None</td></tr> |
| 115 </dl><dl> | 140 </dl><dl> |
| 116 <dt>Returns:</dt> | 141 <dt>Returns:</dt> |
| 117 <dd> | 142 <dd> |
| 118 language of the file or None if not found (str or None) | 143 language of the file or None if not found (str or None) |
| 119 </dd> | 144 </dd> |
| 145 </dl><a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a> | |
| 146 <h4>SyntaxCheckService.__serviceError</h4> | |
| 147 <b>__serviceError</b>(<i>fn, msg</i>) | |
| 148 <p> | |
| 149 Private slot handling service errors. | |
| 150 </p><dl> | |
| 151 <dt><i>fn</i></dt> | |
| 152 <dd> | |
| 153 file name (string) | |
| 154 </dd><dt><i>msg</i></dt> | |
| 155 <dd> | |
| 156 message text (string) | |
| 157 </dd> | |
| 120 </dl><a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a> | 158 </dl><a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a> |
| 121 <h4>SyntaxCheckService.addLanguage</h4> | 159 <h4>SyntaxCheckService.addLanguage</h4> |
| 122 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>) | 160 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>) |
| 123 <p> | 161 <p> |
| 124 Public method to register a new language to the supported languages. | 162 Public method to register a new language to the supported languages. |
| 149 </dd><dt><i>onError</i></dt> | 187 </dd><dt><i>onError</i></dt> |
| 150 <dd> | 188 <dd> |
| 151 callback function if client or service isn't available | 189 callback function if client or service isn't available |
| 152 (function) | 190 (function) |
| 153 </dd> | 191 </dd> |
| 154 </dl><a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a> | 192 </dl><a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a> |
| 193 <h4>SyntaxCheckService.batchJobDone</h4> | |
| 194 <b>batchJobDone</b>(<i>fx, lang</i>) | |
| 195 <p> | |
| 196 Public slot handling the completion of a batch job. | |
| 197 </p><dl> | |
| 198 <dt><i>fx</i></dt> | |
| 199 <dd> | |
| 200 service name (string) | |
| 201 </dd><dt><i>lang</i></dt> | |
| 202 <dd> | |
| 203 language (string) | |
| 204 </dd> | |
| 205 </dl><a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a> | |
| 206 <h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4> | |
| 207 <b>cancelSyntaxBatchCheck</b>(<i></i>) | |
| 208 <p> | |
| 209 Public method to cancel all batch jobs. | |
| 210 </p><a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a> | |
| 155 <h4>SyntaxCheckService.getExtensions</h4> | 211 <h4>SyntaxCheckService.getExtensions</h4> |
| 156 <b>getExtensions</b>(<i></i>) | 212 <b>getExtensions</b>(<i></i>) |
| 157 <p> | 213 <p> |
| 158 Public method to return all supported file extensions for the | 214 Public method to return all supported file extensions for the |
| 159 syntax checker dialog. | 215 syntax checker dialog. |
| 180 </p><dl> | 236 </p><dl> |
| 181 <dt><i>lang</i></dt> | 237 <dt><i>lang</i></dt> |
| 182 <dd> | 238 <dd> |
| 183 language to remove (str) | 239 language to remove (str) |
| 184 </dd> | 240 </dd> |
| 241 </dl><a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a> | |
| 242 <h4>SyntaxCheckService.serviceErrorJavaScript</h4> | |
| 243 <b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>) | |
| 244 <p> | |
| 245 Public method handling service errors for JavaScript. | |
| 246 </p><dl> | |
| 247 <dt><i>fx</i></dt> | |
| 248 <dd> | |
| 249 service name (string) | |
| 250 </dd><dt><i>lang</i></dt> | |
| 251 <dd> | |
| 252 language (string) | |
| 253 </dd><dt><i>fn</i></dt> | |
| 254 <dd> | |
| 255 file name (string) | |
| 256 </dd><dt><i>msg</i></dt> | |
| 257 <dd> | |
| 258 message text (string) | |
| 259 </dd> | |
| 260 </dl><a NAME="SyntaxCheckService.serviceErrorPy2" ID="SyntaxCheckService.serviceErrorPy2"></a> | |
| 261 <h4>SyntaxCheckService.serviceErrorPy2</h4> | |
| 262 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>) | |
| 263 <p> | |
| 264 Public method handling service errors for Python 2. | |
| 265 </p><dl> | |
| 266 <dt><i>fx</i></dt> | |
| 267 <dd> | |
| 268 service name (string) | |
| 269 </dd><dt><i>lang</i></dt> | |
| 270 <dd> | |
| 271 language (string) | |
| 272 </dd><dt><i>fn</i></dt> | |
| 273 <dd> | |
| 274 file name (string) | |
| 275 </dd><dt><i>msg</i></dt> | |
| 276 <dd> | |
| 277 message text (string) | |
| 278 </dd> | |
| 279 </dl><a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a> | |
| 280 <h4>SyntaxCheckService.serviceErrorPy3</h4> | |
| 281 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) | |
| 282 <p> | |
| 283 Public method handling service errors for Python 2. | |
| 284 </p><dl> | |
| 285 <dt><i>fx</i></dt> | |
| 286 <dd> | |
| 287 service name (string) | |
| 288 </dd><dt><i>lang</i></dt> | |
| 289 <dd> | |
| 290 language (string) | |
| 291 </dd><dt><i>fn</i></dt> | |
| 292 <dd> | |
| 293 file name (string) | |
| 294 </dd><dt><i>msg</i></dt> | |
| 295 <dd> | |
| 296 message text (string) | |
| 297 </dd> | |
| 298 </dl><a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a> | |
| 299 <h4>SyntaxCheckService.syntaxBatchCheck</h4> | |
| 300 <b>syntaxBatchCheck</b>(<i>argumentsList</i>) | |
| 301 <p> | |
| 302 Public method to prepare a syntax check on multiple source files. | |
| 303 </p><dl> | |
| 304 <dt><i>argumentsList</i></dt> | |
| 305 <dd> | |
| 306 list of arguments tuples with each tuple | |
| 307 containing filename and source (string, string) | |
| 308 </dd> | |
| 185 </dl><a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a> | 309 </dl><a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a> |
| 186 <h4>SyntaxCheckService.syntaxCheck</h4> | 310 <h4>SyntaxCheckService.syntaxCheck</h4> |
| 187 <b>syntaxCheck</b>(<i>lang, filename, source</i>) | 311 <b>syntaxCheck</b>(<i>lang, filename, source</i>) |
| 188 <p> | 312 <p> |
| 189 Public method to prepare to compile one Python source file to Python | 313 Public method to prepare a syntax check of one source file. |
| 190 bytecode and to perform a pyflakes check. | |
| 191 </p><dl> | 314 </p><dl> |
| 192 <dt><i>lang</i></dt> | 315 <dt><i>lang</i></dt> |
| 193 <dd> | 316 <dd> |
| 194 language of the file or None to determine by internal | 317 language of the file or None to determine by internal |
| 195 algorithm (str or None) | 318 algorithm (str or None) |
