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 10341
3fdffd9cc21d
parent 9925
a267ac36dd69
child 10479
856476537696
equal deleted inserted replaced
10340:548b4c7f410e 10341:3fdffd9cc21d
162 <p> 162 <p>
163 Private method to determine the language of the file. 163 Private method to determine the language of the file.
164 </p> 164 </p>
165 <dl> 165 <dl>
166 166
167 <dt><i>filename</i></dt> 167 <dt><i>filename</i> (str)</dt>
168 <dd> 168 <dd>
169 of the sourcefile (str) 169 of the sourcefile
170 </dd> 170 </dd>
171 <dt><i>source</i></dt> 171 <dt><i>source</i> (str)</dt>
172 <dd> 172 <dd>
173 code of the file (str) 173 code of the file
174 </dd> 174 </dd>
175 </dl> 175 </dl>
176 <dl> 176 <dl>
177 <dt>Return:</dt> 177 <dt>Return:</dt>
178 <dd> 178 <dd>
179 language of the file or None if not found (str or None) 179 language of the file or None if not found
180 </dd>
181 </dl>
182 <dl>
183 <dt>Return Type:</dt>
184 <dd>
185 str or None
180 </dd> 186 </dd>
181 </dl> 187 </dl>
182 <a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a> 188 <a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a>
183 <h4>SyntaxCheckService.__serviceError</h4> 189 <h4>SyntaxCheckService.__serviceError</h4>
184 <b>__serviceError</b>(<i>fn, msg</i>) 190 <b>__serviceError</b>(<i>fn, msg</i>)
186 <p> 192 <p>
187 Private slot handling service errors. 193 Private slot handling service errors.
188 </p> 194 </p>
189 <dl> 195 <dl>
190 196
191 <dt><i>fn</i></dt> 197 <dt><i>fn</i> (str)</dt>
192 <dd> 198 <dd>
193 file name (string) 199 file name
194 </dd> 200 </dd>
195 <dt><i>msg</i></dt> 201 <dt><i>msg</i> (str)</dt>
196 <dd> 202 <dd>
197 message text (string) 203 message text
198 </dd> 204 </dd>
199 </dl> 205 </dl>
200 <a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a> 206 <a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a>
201 <h4>SyntaxCheckService.addLanguage</h4> 207 <h4>SyntaxCheckService.addLanguage</h4>
202 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>) 208 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>)
204 <p> 210 <p>
205 Public method to register a new language to the supported languages. 211 Public method to register a new language to the supported languages.
206 </p> 212 </p>
207 <dl> 213 <dl>
208 214
209 <dt><i>lang</i></dt> 215 <dt><i>lang</i> (str)</dt>
210 <dd> 216 <dd>
211 new language to check syntax (str) 217 new language to check syntax
212 </dd> 218 </dd>
213 <dt><i>env</i></dt> 219 <dt><i>env</i> (str)</dt>
214 <dd> 220 <dd>
215 the environment in which the checker is implemented (str) 221 the environment in which the checker is implemented
216 </dd> 222 </dd>
217 <dt><i>path</i></dt> 223 <dt><i>path</i> (str)</dt>
218 <dd> 224 <dd>
219 full path to the module (str) 225 full path to the module
220 </dd> 226 </dd>
221 <dt><i>module</i></dt> 227 <dt><i>module</i> (str)</dt>
222 <dd> 228 <dd>
223 name to import (str) 229 name to import
224 </dd> 230 </dd>
225 <dt><i>getArgs</i></dt> 231 <dt><i>getArgs</i> (function)</dt>
226 <dd> 232 <dd>
227 function to collect the required arguments to call the 233 function to collect the required arguments to call the
228 syntax checker on client side (function) 234 syntax checker on client side
229 </dd> 235 </dd>
230 <dt><i>getExt</i></dt> 236 <dt><i>getExt</i> (function)</dt>
231 <dd> 237 <dd>
232 function that returns the supported file extensions of 238 function that returns the supported file extensions of
233 the syntax checker (function) 239 the syntax checker
234 </dd> 240 </dd>
235 <dt><i>callback</i></dt> 241 <dt><i>callback</i> (function)</dt>
236 <dd> 242 <dd>
237 function on service response (function) 243 function on service response
238 </dd> 244 </dd>
239 <dt><i>onError</i></dt> 245 <dt><i>onError</i> (function)</dt>
240 <dd> 246 <dd>
241 callback function if client or service isn't available 247 callback function if client or service isn't available
242 (function)
243 </dd> 248 </dd>
244 </dl> 249 </dl>
245 <a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a> 250 <a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a>
246 <h4>SyntaxCheckService.batchJobDone</h4> 251 <h4>SyntaxCheckService.batchJobDone</h4>
247 <b>batchJobDone</b>(<i>fx, lang</i>) 252 <b>batchJobDone</b>(<i>fx, lang</i>)
249 <p> 254 <p>
250 Public slot handling the completion of a batch job. 255 Public slot handling the completion of a batch job.
251 </p> 256 </p>
252 <dl> 257 <dl>
253 258
254 <dt><i>fx</i></dt> 259 <dt><i>fx</i> (str)</dt>
255 <dd> 260 <dd>
256 service name (string) 261 service name
257 </dd> 262 </dd>
258 <dt><i>lang</i></dt> 263 <dt><i>lang</i> (str)</dt>
259 <dd> 264 <dd>
260 language (string) 265 language
261 </dd> 266 </dd>
262 </dl> 267 </dl>
263 <a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a> 268 <a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a>
264 <h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4> 269 <h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4>
265 <b>cancelSyntaxBatchCheck</b>(<i></i>) 270 <b>cancelSyntaxBatchCheck</b>(<i></i>)
276 syntax checker dialog. 281 syntax checker dialog.
277 </p> 282 </p>
278 <dl> 283 <dl>
279 <dt>Return:</dt> 284 <dt>Return:</dt>
280 <dd> 285 <dd>
281 set of all supported file extensions (set of str) 286 set of all supported file extensions
287 </dd>
288 </dl>
289 <dl>
290 <dt>Return Type:</dt>
291 <dd>
292 set of str
282 </dd> 293 </dd>
283 </dl> 294 </dl>
284 <a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a> 295 <a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a>
285 <h4>SyntaxCheckService.getLanguages</h4> 296 <h4>SyntaxCheckService.getLanguages</h4>
286 <b>getLanguages</b>(<i></i>) 297 <b>getLanguages</b>(<i></i>)
289 Public method to return the supported language names. 300 Public method to return the supported language names.
290 </p> 301 </p>
291 <dl> 302 <dl>
292 <dt>Return:</dt> 303 <dt>Return:</dt>
293 <dd> 304 <dd>
294 list of languanges supported (list of str) 305 list of languanges supported
306 </dd>
307 </dl>
308 <dl>
309 <dt>Return Type:</dt>
310 <dd>
311 list of str
295 </dd> 312 </dd>
296 </dl> 313 </dl>
297 <a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a> 314 <a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a>
298 <h4>SyntaxCheckService.removeLanguage</h4> 315 <h4>SyntaxCheckService.removeLanguage</h4>
299 <b>removeLanguage</b>(<i>lang</i>) 316 <b>removeLanguage</b>(<i>lang</i>)
301 <p> 318 <p>
302 Public method to remove the language from syntax check. 319 Public method to remove the language from syntax check.
303 </p> 320 </p>
304 <dl> 321 <dl>
305 322
306 <dt><i>lang</i></dt> 323 <dt><i>lang</i> (str)</dt>
307 <dd> 324 <dd>
308 language to remove (str) 325 language to remove
309 </dd> 326 </dd>
310 </dl> 327 </dl>
311 <a NAME="SyntaxCheckService.serviceErrorJSON" ID="SyntaxCheckService.serviceErrorJSON"></a> 328 <a NAME="SyntaxCheckService.serviceErrorJSON" ID="SyntaxCheckService.serviceErrorJSON"></a>
312 <h4>SyntaxCheckService.serviceErrorJSON</h4> 329 <h4>SyntaxCheckService.serviceErrorJSON</h4>
313 <b>serviceErrorJSON</b>(<i>fx, lang, fn, msg</i>) 330 <b>serviceErrorJSON</b>(<i>fx, lang, fn, msg</i>)
315 <p> 332 <p>
316 Public method handling service errors for JSON. 333 Public method handling service errors for JSON.
317 </p> 334 </p>
318 <dl> 335 <dl>
319 336
320 <dt><i>fx</i></dt> 337 <dt><i>fx</i> (str)</dt>
321 <dd> 338 <dd>
322 service name (string) 339 service name
323 </dd> 340 </dd>
324 <dt><i>lang</i></dt> 341 <dt><i>lang</i> (str)</dt>
325 <dd> 342 <dd>
326 language (string) 343 language
327 </dd> 344 </dd>
328 <dt><i>fn</i></dt> 345 <dt><i>fn</i> (str)</dt>
329 <dd> 346 <dd>
330 file name (string) 347 file name
331 </dd> 348 </dd>
332 <dt><i>msg</i></dt> 349 <dt><i>msg</i> (str)</dt>
333 <dd> 350 <dd>
334 message text (string) 351 message text
335 </dd> 352 </dd>
336 </dl> 353 </dl>
337 <a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a> 354 <a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a>
338 <h4>SyntaxCheckService.serviceErrorJavaScript</h4> 355 <h4>SyntaxCheckService.serviceErrorJavaScript</h4>
339 <b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>) 356 <b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>)
341 <p> 358 <p>
342 Public method handling service errors for JavaScript. 359 Public method handling service errors for JavaScript.
343 </p> 360 </p>
344 <dl> 361 <dl>
345 362
346 <dt><i>fx</i></dt> 363 <dt><i>fx</i> (str)</dt>
347 <dd> 364 <dd>
348 service name (string) 365 service name
349 </dd> 366 </dd>
350 <dt><i>lang</i></dt> 367 <dt><i>lang</i> (str)</dt>
351 <dd> 368 <dd>
352 language (string) 369 language
353 </dd> 370 </dd>
354 <dt><i>fn</i></dt> 371 <dt><i>fn</i> (str)</dt>
355 <dd> 372 <dd>
356 file name (string) 373 file name
357 </dd> 374 </dd>
358 <dt><i>msg</i></dt> 375 <dt><i>msg</i> (str)</dt>
359 <dd> 376 <dd>
360 message text (string) 377 message text
361 </dd> 378 </dd>
362 </dl> 379 </dl>
363 <a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a> 380 <a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a>
364 <h4>SyntaxCheckService.serviceErrorPy3</h4> 381 <h4>SyntaxCheckService.serviceErrorPy3</h4>
365 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>) 382 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
367 <p> 384 <p>
368 Public method handling service errors for Python 3. 385 Public method handling service errors for Python 3.
369 </p> 386 </p>
370 <dl> 387 <dl>
371 388
372 <dt><i>fx</i></dt> 389 <dt><i>fx</i> (str)</dt>
373 <dd> 390 <dd>
374 service name (string) 391 service name
375 </dd> 392 </dd>
376 <dt><i>lang</i></dt> 393 <dt><i>lang</i> (str)</dt>
377 <dd> 394 <dd>
378 language (string) 395 language
379 </dd> 396 </dd>
380 <dt><i>fn</i></dt> 397 <dt><i>fn</i> (str)</dt>
381 <dd> 398 <dd>
382 file name (string) 399 file name
383 </dd> 400 </dd>
384 <dt><i>msg</i></dt> 401 <dt><i>msg</i> (str)</dt>
385 <dd> 402 <dd>
386 message text (string) 403 message text
387 </dd> 404 </dd>
388 </dl> 405 </dl>
389 <a NAME="SyntaxCheckService.serviceErrorTOML" ID="SyntaxCheckService.serviceErrorTOML"></a> 406 <a NAME="SyntaxCheckService.serviceErrorTOML" ID="SyntaxCheckService.serviceErrorTOML"></a>
390 <h4>SyntaxCheckService.serviceErrorTOML</h4> 407 <h4>SyntaxCheckService.serviceErrorTOML</h4>
391 <b>serviceErrorTOML</b>(<i>fx, lang, fn, msg</i>) 408 <b>serviceErrorTOML</b>(<i>fx, lang, fn, msg</i>)
393 <p> 410 <p>
394 Public method handling service errors for TOML. 411 Public method handling service errors for TOML.
395 </p> 412 </p>
396 <dl> 413 <dl>
397 414
398 <dt><i>fx</i></dt> 415 <dt><i>fx</i> (str)</dt>
399 <dd> 416 <dd>
400 service name (string) 417 service name
401 </dd> 418 </dd>
402 <dt><i>lang</i></dt> 419 <dt><i>lang</i> (str)</dt>
403 <dd> 420 <dd>
404 language (string) 421 language
405 </dd> 422 </dd>
406 <dt><i>fn</i></dt> 423 <dt><i>fn</i> (str)</dt>
407 <dd> 424 <dd>
408 file name (string) 425 file name
409 </dd> 426 </dd>
410 <dt><i>msg</i></dt> 427 <dt><i>msg</i> (str)</dt>
411 <dd> 428 <dd>
412 message text (string) 429 message text
413 </dd> 430 </dd>
414 </dl> 431 </dl>
415 <a NAME="SyntaxCheckService.serviceErrorYAML" ID="SyntaxCheckService.serviceErrorYAML"></a> 432 <a NAME="SyntaxCheckService.serviceErrorYAML" ID="SyntaxCheckService.serviceErrorYAML"></a>
416 <h4>SyntaxCheckService.serviceErrorYAML</h4> 433 <h4>SyntaxCheckService.serviceErrorYAML</h4>
417 <b>serviceErrorYAML</b>(<i>fx, lang, fn, msg</i>) 434 <b>serviceErrorYAML</b>(<i>fx, lang, fn, msg</i>)
419 <p> 436 <p>
420 Public method handling service errors for YAML. 437 Public method handling service errors for YAML.
421 </p> 438 </p>
422 <dl> 439 <dl>
423 440
424 <dt><i>fx</i></dt> 441 <dt><i>fx</i> (str)</dt>
425 <dd> 442 <dd>
426 service name (string) 443 service name
427 </dd> 444 </dd>
428 <dt><i>lang</i></dt> 445 <dt><i>lang</i> (str)</dt>
429 <dd> 446 <dd>
430 language (string) 447 language
431 </dd> 448 </dd>
432 <dt><i>fn</i></dt> 449 <dt><i>fn</i> (str)</dt>
433 <dd> 450 <dd>
434 file name (string) 451 file name
435 </dd> 452 </dd>
436 <dt><i>msg</i></dt> 453 <dt><i>msg</i> (str)</dt>
437 <dd> 454 <dd>
438 message text (string) 455 message text
439 </dd> 456 </dd>
440 </dl> 457 </dl>
441 <a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a> 458 <a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a>
442 <h4>SyntaxCheckService.syntaxBatchCheck</h4> 459 <h4>SyntaxCheckService.syntaxBatchCheck</h4>
443 <b>syntaxBatchCheck</b>(<i>argumentsList</i>) 460 <b>syntaxBatchCheck</b>(<i>argumentsList</i>)
445 <p> 462 <p>
446 Public method to prepare a syntax check on multiple source files. 463 Public method to prepare a syntax check on multiple source files.
447 </p> 464 </p>
448 <dl> 465 <dl>
449 466
450 <dt><i>argumentsList</i></dt> 467 <dt><i>argumentsList</i> (list of tuples of (str, str))</dt>
451 <dd> 468 <dd>
452 list of arguments tuples with each tuple 469 list of argument tuples with each tuple
453 containing filename and source (string, string) 470 containing filename and source
454 </dd> 471 </dd>
455 </dl> 472 </dl>
456 <a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a> 473 <a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a>
457 <h4>SyntaxCheckService.syntaxCheck</h4> 474 <h4>SyntaxCheckService.syntaxCheck</h4>
458 <b>syntaxCheck</b>(<i>lang, filename, source, *args</i>) 475 <b>syntaxCheck</b>(<i>lang, filename, source, *args</i>)

Mercurial Repository: eric

eric ide

mercurial