Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html

eric6/Documentation/Source/eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService.html

changeset 6942
2602857055c5
parent 4503
d68dcbe1deb3
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.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><a NAME="top" ID="top"></a>
22 <h1>eric6.Plugins.CheckerPlugins.SyntaxChecker.SyntaxCheckService</h1>
23 <p>
24 Module implementing an interface to add different languages to do a syntax
25 check.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#SyntaxCheckService">SyntaxCheckService</a></td>
35 <td>Implement the syntax check service.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="SyntaxCheckService" ID="SyntaxCheckService"></a>
44 <h2>SyntaxCheckService</h2>
45 <p>
46 Implement the syntax check service.
47 </p><p>
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
50 connect directly to the background service.
51 </p><h3>Signals</h3>
52 <dl>
53 <dt>batchFinished()</dt>
54 <dd>
55 emitted when a syntax check batch is done
56 </dd><dt>error(str, str)</dt>
57 <dd>
58 emitted in case of an error
59 </dd><dt>syntaxChecked(str, dict)</dt>
60 <dd>
61 emitted when the syntax check was done for
62 one file
63 </dd>
64 </dl>
65 <h3>Derived from</h3>
66 QObject
67 <h3>Class Attributes</h3>
68 <table>
69 <tr><td>None</td></tr>
70 </table>
71 <h3>Class Methods</h3>
72 <table>
73 <tr><td>None</td></tr>
74 </table>
75 <h3>Methods</h3>
76 <table>
77 <tr>
78 <td><a href="#SyntaxCheckService.__init__">SyntaxCheckService</a></td>
79 <td>Constructor</td>
80 </tr><tr>
81 <td><a href="#SyntaxCheckService.__determineLanguage">__determineLanguage</a></td>
82 <td>Private methode to determine the language of the file.</td>
83 </tr><tr>
84 <td><a href="#SyntaxCheckService.__serviceError">__serviceError</a></td>
85 <td>Private slot handling service errors.</td>
86 </tr><tr>
87 <td><a href="#SyntaxCheckService.addLanguage">addLanguage</a></td>
88 <td>Public method to register a new language to the supported languages.</td>
89 </tr><tr>
90 <td><a href="#SyntaxCheckService.batchJobDone">batchJobDone</a></td>
91 <td>Public slot handling the completion of a batch job.</td>
92 </tr><tr>
93 <td><a href="#SyntaxCheckService.cancelSyntaxBatchCheck">cancelSyntaxBatchCheck</a></td>
94 <td>Public method to cancel all batch jobs.</td>
95 </tr><tr>
96 <td><a href="#SyntaxCheckService.getExtensions">getExtensions</a></td>
97 <td>Public method to return all supported file extensions for the syntax checker dialog.</td>
98 </tr><tr>
99 <td><a href="#SyntaxCheckService.getLanguages">getLanguages</a></td>
100 <td>Public method to return the supported language names.</td>
101 </tr><tr>
102 <td><a href="#SyntaxCheckService.removeLanguage">removeLanguage</a></td>
103 <td>Public method to remove the language from syntax check.</td>
104 </tr><tr>
105 <td><a href="#SyntaxCheckService.serviceErrorJavaScript">serviceErrorJavaScript</a></td>
106 <td>Public method handling service errors for JavaScript.</td>
107 </tr><tr>
108 <td><a href="#SyntaxCheckService.serviceErrorPy2">serviceErrorPy2</a></td>
109 <td>Public method handling service errors for Python 2.</td>
110 </tr><tr>
111 <td><a href="#SyntaxCheckService.serviceErrorPy3">serviceErrorPy3</a></td>
112 <td>Public method handling service errors for Python 2.</td>
113 </tr><tr>
114 <td><a href="#SyntaxCheckService.syntaxBatchCheck">syntaxBatchCheck</a></td>
115 <td>Public method to prepare a syntax check on multiple source files.</td>
116 </tr><tr>
117 <td><a href="#SyntaxCheckService.syntaxCheck">syntaxCheck</a></td>
118 <td>Public method to prepare a syntax check of one source file.</td>
119 </tr>
120 </table>
121 <h3>Static Methods</h3>
122 <table>
123 <tr><td>None</td></tr>
124 </table>
125 <a NAME="SyntaxCheckService.__init__" ID="SyntaxCheckService.__init__"></a>
126 <h4>SyntaxCheckService (Constructor)</h4>
127 <b>SyntaxCheckService</b>(<i></i>)
128 <p>
129 Constructor
130 </p><a NAME="SyntaxCheckService.__determineLanguage" ID="SyntaxCheckService.__determineLanguage"></a>
131 <h4>SyntaxCheckService.__determineLanguage</h4>
132 <b>__determineLanguage</b>(<i>filename, source</i>)
133 <p>
134 Private methode to determine the language of the file.
135 </p><dl>
136 <dt><i>filename</i></dt>
137 <dd>
138 of the sourcefile (str)
139 </dd><dt><i>source</i></dt>
140 <dd>
141 code of the file (str)
142 </dd>
143 </dl><dl>
144 <dt>Returns:</dt>
145 <dd>
146 language of the file or None if not found (str or None)
147 </dd>
148 </dl><a NAME="SyntaxCheckService.__serviceError" ID="SyntaxCheckService.__serviceError"></a>
149 <h4>SyntaxCheckService.__serviceError</h4>
150 <b>__serviceError</b>(<i>fn, msg</i>)
151 <p>
152 Private slot handling service errors.
153 </p><dl>
154 <dt><i>fn</i></dt>
155 <dd>
156 file name (string)
157 </dd><dt><i>msg</i></dt>
158 <dd>
159 message text (string)
160 </dd>
161 </dl><a NAME="SyntaxCheckService.addLanguage" ID="SyntaxCheckService.addLanguage"></a>
162 <h4>SyntaxCheckService.addLanguage</h4>
163 <b>addLanguage</b>(<i>lang, env, path, module, getArgs, getExt, callback, onError</i>)
164 <p>
165 Public method to register a new language to the supported languages.
166 </p><dl>
167 <dt><i>lang</i></dt>
168 <dd>
169 new language to check syntax (str)
170 </dd><dt><i>env</i></dt>
171 <dd>
172 the environment in which the checker is implemented (str)
173 </dd><dt><i>path</i></dt>
174 <dd>
175 full path to the module (str)
176 </dd><dt><i>module</i></dt>
177 <dd>
178 name to import (str)
179 </dd><dt><i>getArgs</i></dt>
180 <dd>
181 function to collect the required arguments to call the
182 syntax checker on client side (function)
183 </dd><dt><i>getExt</i></dt>
184 <dd>
185 function that returns the supported file extensions of
186 the syntax checker (function)
187 </dd><dt><i>callback</i></dt>
188 <dd>
189 function on service response (function)
190 </dd><dt><i>onError</i></dt>
191 <dd>
192 callback function if client or service isn't available
193 (function)
194 </dd>
195 </dl><a NAME="SyntaxCheckService.batchJobDone" ID="SyntaxCheckService.batchJobDone"></a>
196 <h4>SyntaxCheckService.batchJobDone</h4>
197 <b>batchJobDone</b>(<i>fx, lang</i>)
198 <p>
199 Public slot handling the completion of a batch job.
200 </p><dl>
201 <dt><i>fx</i></dt>
202 <dd>
203 service name (string)
204 </dd><dt><i>lang</i></dt>
205 <dd>
206 language (string)
207 </dd>
208 </dl><a NAME="SyntaxCheckService.cancelSyntaxBatchCheck" ID="SyntaxCheckService.cancelSyntaxBatchCheck"></a>
209 <h4>SyntaxCheckService.cancelSyntaxBatchCheck</h4>
210 <b>cancelSyntaxBatchCheck</b>(<i></i>)
211 <p>
212 Public method to cancel all batch jobs.
213 </p><a NAME="SyntaxCheckService.getExtensions" ID="SyntaxCheckService.getExtensions"></a>
214 <h4>SyntaxCheckService.getExtensions</h4>
215 <b>getExtensions</b>(<i></i>)
216 <p>
217 Public method to return all supported file extensions for the
218 syntax checker dialog.
219 </p><dl>
220 <dt>Returns:</dt>
221 <dd>
222 set of all supported file extensions (set of str)
223 </dd>
224 </dl><a NAME="SyntaxCheckService.getLanguages" ID="SyntaxCheckService.getLanguages"></a>
225 <h4>SyntaxCheckService.getLanguages</h4>
226 <b>getLanguages</b>(<i></i>)
227 <p>
228 Public method to return the supported language names.
229 </p><dl>
230 <dt>Returns:</dt>
231 <dd>
232 list of languanges supported (list of str)
233 </dd>
234 </dl><a NAME="SyntaxCheckService.removeLanguage" ID="SyntaxCheckService.removeLanguage"></a>
235 <h4>SyntaxCheckService.removeLanguage</h4>
236 <b>removeLanguage</b>(<i>lang</i>)
237 <p>
238 Public method to remove the language from syntax check.
239 </p><dl>
240 <dt><i>lang</i></dt>
241 <dd>
242 language to remove (str)
243 </dd>
244 </dl><a NAME="SyntaxCheckService.serviceErrorJavaScript" ID="SyntaxCheckService.serviceErrorJavaScript"></a>
245 <h4>SyntaxCheckService.serviceErrorJavaScript</h4>
246 <b>serviceErrorJavaScript</b>(<i>fx, lang, fn, msg</i>)
247 <p>
248 Public method handling service errors for JavaScript.
249 </p><dl>
250 <dt><i>fx</i></dt>
251 <dd>
252 service name (string)
253 </dd><dt><i>lang</i></dt>
254 <dd>
255 language (string)
256 </dd><dt><i>fn</i></dt>
257 <dd>
258 file name (string)
259 </dd><dt><i>msg</i></dt>
260 <dd>
261 message text (string)
262 </dd>
263 </dl><a NAME="SyntaxCheckService.serviceErrorPy2" ID="SyntaxCheckService.serviceErrorPy2"></a>
264 <h4>SyntaxCheckService.serviceErrorPy2</h4>
265 <b>serviceErrorPy2</b>(<i>fx, lang, fn, msg</i>)
266 <p>
267 Public method handling service errors for Python 2.
268 </p><dl>
269 <dt><i>fx</i></dt>
270 <dd>
271 service name (string)
272 </dd><dt><i>lang</i></dt>
273 <dd>
274 language (string)
275 </dd><dt><i>fn</i></dt>
276 <dd>
277 file name (string)
278 </dd><dt><i>msg</i></dt>
279 <dd>
280 message text (string)
281 </dd>
282 </dl><a NAME="SyntaxCheckService.serviceErrorPy3" ID="SyntaxCheckService.serviceErrorPy3"></a>
283 <h4>SyntaxCheckService.serviceErrorPy3</h4>
284 <b>serviceErrorPy3</b>(<i>fx, lang, fn, msg</i>)
285 <p>
286 Public method handling service errors for Python 2.
287 </p><dl>
288 <dt><i>fx</i></dt>
289 <dd>
290 service name (string)
291 </dd><dt><i>lang</i></dt>
292 <dd>
293 language (string)
294 </dd><dt><i>fn</i></dt>
295 <dd>
296 file name (string)
297 </dd><dt><i>msg</i></dt>
298 <dd>
299 message text (string)
300 </dd>
301 </dl><a NAME="SyntaxCheckService.syntaxBatchCheck" ID="SyntaxCheckService.syntaxBatchCheck"></a>
302 <h4>SyntaxCheckService.syntaxBatchCheck</h4>
303 <b>syntaxBatchCheck</b>(<i>argumentsList</i>)
304 <p>
305 Public method to prepare a syntax check on multiple source files.
306 </p><dl>
307 <dt><i>argumentsList</i></dt>
308 <dd>
309 list of arguments tuples with each tuple
310 containing filename and source (string, string)
311 </dd>
312 </dl><a NAME="SyntaxCheckService.syntaxCheck" ID="SyntaxCheckService.syntaxCheck"></a>
313 <h4>SyntaxCheckService.syntaxCheck</h4>
314 <b>syntaxCheck</b>(<i>lang, filename, source</i>)
315 <p>
316 Public method to prepare a syntax check of one source file.
317 </p><dl>
318 <dt><i>lang</i></dt>
319 <dd>
320 language of the file or None to determine by internal
321 algorithm (str or None)
322 </dd><dt><i>filename</i></dt>
323 <dd>
324 source filename (string)
325 </dd><dt><i>source</i></dt>
326 <dd>
327 string containing the code to check (string)
328 </dd>
329 </dl>
330 <div align="right"><a href="#top">Up</a></div>
331 <hr />
332 </body></html>

Mercurial Repository: eric

eric ide

mercurial