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